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

   1 /*
   2  * Copyright (C) 1995-2008 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  * @version   $Id$
  25  * @summary
  26  *  Central FIRM header.
  27  *
  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
  30  *  optimizations.
  31  *
  32  *  This header is the central header of the library implementation of this
  33  *  IR.
  34  *
  35  *  The internal representation of a program in firm is separated into five
  36  *  different modules:
  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.)
  53  *
  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).
  58  */
  59 #ifndef FIRM_COMMON_FIRM_H
  60 #define FIRM_COMMON_FIRM_H
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 /* The representations */
  67 #include "firm_common.h"   /* common type tags. */
  68 #include "irprog.h"        /* control flow and data of a program */
  69 #include "irgraph.h"       /* graphs */
  70 #include "typerep.h"       /* type representation */
  71 #include "tv.h"            /* target values */
  72 #include "irnode.h"
  73 #include "irop.h"
  74 #include "ident.h"         /* source code identificators */
  75
  76 /* Functionality */
  77 #include "ircons.h"        /* construct ir */
  78 #include "ircgcons.h"      /* construct interprocedural graph */
  79
  80 /* Optimizations */
  81 #include "irflag.h"         /* optimization flags */
  82 #include "irgopt.h"         /* optimize ir */
  83 #include "iroptimize.h"     /* optimize ir by reassociation */
  84 #include "ircgopt.h"        /* Optimizations based on interprocedural graph */
  85 #include "iropt.h"
  86
  87 /* Lowering */
  88 #include "lowering.h"         /* lowering of different calls parameters, intrinsic calls, double word types, high-level constructs */
  89
  90 /* Analyses */
  91 #include "irouts.h"           /* Graph reversal / out edges. */
  92 #include "trouts.h"           /* Graph reversal / out edges for types. */
  93 #include "irdom.h"            /* Dominator analysis */
  94 #include "cgana.h"            /* Analysis to construct interprocedural graph */
  95                               /* including some optimizations */
  96 #include "irloop.h"           /* loop and backedge analysis */
  97 #include "callgraph.h"        /* Callgraph construction */
  98 #include "irconsconfirm.h"    /* Confirm nodes */
  99 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
 100 #include "irtypeinfo.h"       /* type information for nodes */
 101 #include "irmemory.h"         /* memory disambiguation */
 102 #include "interval_analysis.h"
 103 #include "field_temperature.h"
 104 #include "execution_frequency.h"
 105
 106 /* Support */
 107 #include "irgmod.h"         /* Support to modify ir */
 108 #include "irgwalk.h"        /* Support to walk ir */
 109
 110 #include "irarch.h"        /* architecture dependent optimizations */
 111
 112 #include "firmstat.h"      /* statistics */
 113
 114 #include "dbginfo.h"       /* debug support */
 115 #include "seqnumbers.h"    /* debug support */
 116
 117 #include "irdump.h"
 118 #include "irio.h"
 119 #include "irprintf.h"
 120 #include "irvrfy.h"
 121
 122 #include "irarch.h"
 123
 124 #include "iredges.h"
 125
 126 #include "be.h"
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 #endif