nsz Git - libfirm/blob - include/libfirm/firm.h

   1 /*
   2  * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief     Central firm header.
  23  * @author    Martin Trapp, Christian Schaefer, Goetz Lindenmaier
  24  * @brief     Central FIRM header.
  25  */
  26
  27 /** @mainpage
  28  *
  29  *  FIRM is a full graph based intermediate representation in SSA Form
  30  *  with a novel concept to model side effects.  It allows fast, aggressive
  31  *  optimizations.
  32  *
  33  *  This header is the central header of the library implementation of this
  34  *  IR.
  35  *
  36  *  The internal representation of a program in firm is separated into five
  37  *  different modules:
  38  *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
  39  *     Firm Graphs are assembled out of several data structures:
  40  *     irprog: represents a program.  Allows access to all types and all
  41  *       FIRM graphs for procedures and other global things.
  42  *     irgraph: represents a procedure.  Allows access to the code of the
  43  *       procedure, the actual FIRM graph.
  44  *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
  45  *   and represent instructions in a program.
  46  *     irop: The opcode of FIRM nodes.
  47  *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
  48  *       data types (int, float, pointer).
  49  *   - Entities representing program known objects. (Subdirectory tr.)
  50  *     All variables and procedures are entities.
  51  *   - Types describing the type system for the program. (Subdirectory tr.)
  52  *   - Target Values representing program known constants. (Subdirectory tv.)
  53  *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
  54  *
  55  *   Further this library supplies functionality to build and optimize FIRM graphs
  56  *   and further functionality needed in a compiler.  Finally there is more
  57  *   generic functionality to support implementations using firm.
  58  *   (Code generation, further optimizations).
  59  */
  60 #ifndef FIRM_COMMON_FIRM_H
  61 #define FIRM_COMMON_FIRM_H
  62
  63 #include "analyze_irg_args.h"
  64 #include "be.h"
  65 #include "callgraph.h"
  66 #include "cdep.h"
  67 #include "cgana.h"
  68 #include "dbginfo.h"
  69 #include "execfreq.h"
  70 #include "firm_common.h"
  71 #include "firmstat.h"
  72 #include "firm_types.h"
  73 #include "heights.h"
  74 #include "ident.h"
  75 #include "irarch.h"
  76 #include "ircgopt.h"
  77 #include "irconsconfirm.h"
  78 #include "ircons.h"
  79 #include "irdom.h"
  80 #include "vrp.h"
  81 #include "irdump.h"
  82 #include "iredgekinds.h"
  83 #include "iredges.h"
  84 #include "irextbb.h"
  85 #include "irflag.h"
  86 #include "irgmod.h"
  87 #include "irgopt.h"
  88 #include "irgraph.h"
  89 #include "irgwalk.h"
  90 #include "irhooks.h"
  91 #include "irio.h"
  92 #include "irloop.h"
  93 #include "irmemory.h"
  94 #include "irmode.h"
  95 #include "irnode.h"
  96 #include "irop.h"
  97 #include "iropt.h"
  98 #include "iroptimize.h"
  99 #include "irouts.h"
 100 #include "irpass.h"
 101 #include "irprintf.h"
 102 #include "irprog.h"
 103 #include "irtypeinfo.h"
 104 #include "irverify.h"
 105 #include "lowering.h"
 106 #include "timing.h"
 107 #include "trouts.h"
 108 #include "tv.h"
 109 #include "typerep.h"
 110
 111 #endif