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 "ident.h"         /* source code identificators */
  73
  74 /* Functionality */
  75 #include "ircons.h"        /* construct ir */
  76 #include "ircgcons.h"      /* construct interprocedural graph */
  77
  78 /* Optimizations */
  79 #include "irflag.h"         /* optimization flags */
  80 #include "irgopt.h"         /* optimize ir */
  81 #include "iroptimize.h"     /* optimize ir by reassociation */
  82 #include "ircgopt.h"        /* Optimizations based on interprocedural graph */
  83
  84 /* Lowering */
  85 #include "lowering.h"         /* lowering of different calls parameters, intrinsic calls, double word types, high-level constructs */
  86
  87 /* Analyses */
  88 #include "irouts.h"           /* Graph reversal / out edges. */
  89 #include "trouts.h"           /* Graph reversal / out edges for types. */
  90 #include "irdom.h"            /* Dominator analysis */
  91 #include "cgana.h"            /* Analysis to construct interprocedural graph */
  92                               /* including some optimizations */
  93 #include "irloop.h"           /* loop and backedge analysis */
  94 #include "callgraph.h"        /* Callgraph construction */
  95 #include "irconsconfirm.h"    /* Confirm nodes */
  96 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
  97 #include "irtypeinfo.h"       /* type information for nodes */
  98 #include "irmemory.h"         /* memory disambiguation */
  99 #include "interval_analysis.h"
 100 #include "field_temperature.h"
 101 #include "execution_frequency.h"
 102
 103 /* Support */
 104 #include "irgmod.h"         /* Support to modify ir */
 105 #include "irgwalk.h"        /* Support to walk ir */
 106
 107 #include "irarch.h"        /* architecture dependent optimizations */
 108
 109 #include "firmstat.h"      /* statistics */
 110
 111 #include "dbginfo.h"       /* debug support */
 112 #include "seqnumbers.h"    /* debug support */
 113 #include "firm_ycomp.h"    /* ycomp debugging support */
 114
 115 #include "irdump.h"
 116 #include "irprintf.h"
 117 #include "irvrfy.h"
 118
 119 #include "irarch.h"
 120
 121 #include "iredges.h"
 122
 123 #include "be.h"
 124
 125 /**
 126  * libFirm initialization parameters.
 127  */
 128 struct _firm_parameter_t {
 129   /**
 130    * The size of this structure. init_firm() will only initialize
 131    * this amount of data. This allows to add more fields to this structure
 132    * without breaking compatibility to older source.
 133    */
 134   unsigned int size;
 135
 136   /**
 137    * Statistic options. If statistic function where enabled, these
 138    * flags configure it, see enum firmstat_options_t.
 139    */
 140   unsigned enable_statistics;
 141
 142   /**
 143    * This function is called, whenever a local variable is
 144    * used before definition. The function should insert a default value,
 145    * and/or raise a compiler error/warning. Note that returning
 146    * an Unknown is allowed here.
 147    */
 148   uninitialized_local_variable_func_t *initialize_local_func;
 149
 150   /**
 151    * The interface functions for the type identification module.
 152    * If not set, the default implementation with compare_strict() and
 153    * firm_hash_name() will be used.
 154    */
 155   type_identify_if_t *ti_if;
 156
 157   /**
 158    * The interface for the ident module.
 159    * If not set, the default libFirm ident module (using hash sets).
 160    */
 161   ident_if_t *id_if;
 162
 163   /**
 164    * The default calling convention.
 165    */
 166   unsigned cc_mask;
 167
 168   /**
 169    * The debug info that should be used for "builtin" objects.
 170    */
 171   dbg_info *builtin_dbg;
 172 };
 173
 174 typedef struct _firm_parameter_t firm_parameter_t;
 175
 176 /**
 177  * Initialize the firm library.
 178  *
 179  * Initializes the firm library.  Allocates default data structures.
 180  * Initializes configurable behavior of the library.
 181  *
 182  * @param params   A structure containing the parameters of the libFirm.
 183  *
 184  * The parameter struct may be NULL. In that case, the original FIRM behavior
 185  * is conserved.
 186  */
 187 void ir_init(const firm_parameter_t *params);
 188
 189 /**
 190  * Frees all memory occupied by the firm library.
 191  */
 192 void ir_finish(void);
 193
 194 /** returns the libFirm major version number */
 195 unsigned ir_get_version_major(void);
 196 /** returns libFirm minor version number */
 197 unsigned ir_get_version_minor(void);
 198 /** returns string describing libFirm revision */
 199 const char *ir_get_version_revision(void);
 200 /** returns string describing libFirm build */
 201 const char *ir_get_version_build(void);
 202
 203 #ifdef __cplusplus
 204 }
 205 #endif
 206
 207 #endif