nsz Git - libfirm/blob - ir/common/firm.h

   1 /*
   2  * Copyright (C) 1995-2007 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 "type.h"          /* type representation */
  71 #include "entity.h"        /* entity representation */
  72 #include "tv.h"            /* target values */
  73 #include "ident.h"         /* source code identificators */
  74
  75 /* Functionality */
  76 #include "ircons.h"        /* construct ir */
  77 #include "ircgcons.h"      /* construct interprocedural graph */
  78
  79 /* Optimizations */
  80 #include "irflag.h"         /* optimization flags */
  81 #include "irgopt.h"         /* optimize ir */
  82 #include "reassoc.h"        /* optimize ir by reassociation */
  83 #include "ldstopt.h"        /* optimize Load/Store */
  84 #include "cfopt.h"          /* optimize control flow */
  85 #include "tailrec.h"        /* optimize tail-recursion calls */
  86 #include "ircgopt.h"        /* Optimizations based on interprocedural graph */
  87 #include "opt_osr.h"        /* Operator Strength Reduction */
  88 #include "strength_red.h"   /* Old (and buggy) Strength reduction */
  89 #include "loop_unrolling.h" /* Do loop unrolling */
  90 #include "ifconv.h"         /* if conversion */
  91 #include "funccall.h"       /* real function call optimization */
  92 #include "return.h"         /* Return node normalizations */
  93 #include "scalar_replace.h" /* Scalar replacement */
  94 #include "proc_cloning.h"   /* procedure cloning */
  95 #include "opt_confirms.h"   /* Confirm based optimizations */
  96 #include "gvn_pre.h"        /* global value numbering and partial redundancy elimination */
  97 #include "opt_frame.h"      /* frame type optimization */
  98 #include "tropt.h"          /* optimize the type representation */
  99 #include "condeval.h"       /* control flow optimization by conditional evaluation */
 100
 101 /* Lowering */
 102 #include "lower_calls.h"      /* lowering of different calls */
 103 #include "lower_intrinsics.h" /* lowering of intrinsic calls */
 104 #include "lower_dw.h"         /* double word types lowering */
 105
 106 /* Analyses */
 107 #include "irouts.h"           /* Graph reversal / out edges. */
 108 #include "trouts.h"           /* Graph reversal / out edges for types. */
 109 #include "irdom.h"            /* Dominator analysis */
 110 #include "cgana.h"            /* Analysis to construct interprocedural graph */
 111                               /* including some optimizations */
 112 #include "irloop.h"           /* loop and backedge analysis */
 113 #include "callgraph.h"        /* Callgraph construction */
 114 #include "irconsconfirm.h"    /* Confirm nodes */
 115 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
 116 #include "irtypeinfo.h"       /* type information for nodes */
 117 #include "irmemory.h"         /* memory disambiguation */
 118 #include "interval_analysis.h"
 119 #include "field_temperature.h"
 120 #include "execution_frequency.h"
 121
 122 /* Support */
 123 #include "irgmod.h"         /* Support to modify ir */
 124 #include "irgwalk.h"        /* Support to walk ir */
 125 #include "typewalk.h"       /* Support to walk type information */
 126 #include "typegmod.h"       /* Support to modify type graph */
 127 #include "type_identify.h"  /* Support for type identification */
 128 #include "mangle.h"         /* Support for mangling ident names. */
 129 #include "tr_inheritance.h" /* Support to handle inheritance. */
 130
 131 #include "irarch.h"        /* architecture dependent optimizations */
 132 #include "archop.h"        /* architecture dependent opcodes */
 133 //#include "modeconv.h"      /* architecture dependent mode conversion */
 134
 135 #include "firmstat.h"      /* statistics */
 136
 137 #include "irreflect.h"     /* reflection */
 138
 139 #include "seqnumbers.h"    /* debug support */
 140 #include "firm_ycomp.h"    /* ycomp debugging support */
 141
 142
 143 /* @@@ temporarily for jni builder until preprocessor works.
 144    Then it should be sufficient to include <file.h> instead
 145    of firm.h as not all enums are needed in the implementation
 146    files. */
 147 #include "irdump.h"
 148 #include "irprintf.h"
 149 #include "irvrfy.h"
 150 #include "trvrfy.h"
 151
 152 #include "irarch.h"
 153
 154 #include "iredges.h"
 155
 156 /* Macros that define the old function names we decided to rename.
 157    Use for compatibility with old implementations. */
 158 /*#include "old_fctnames.h"*/
 159
 160 /**
 161  * libFirm initialization parameters.
 162  */
 163 struct _firm_parameter_t {
 164   /**
 165    * The size of this structure. init_firm() will only initialize
 166    * this amount of data. This allows to add more fields to this structure
 167    * without breaking compatibility to older source.
 168    */
 169   unsigned int size;
 170
 171   /**
 172    * Statistic options. If statistic function where enabled, these
 173    * flags configure it, see enum firmstat_options_t.
 174    */
 175   unsigned enable_statistics;
 176
 177   /**
 178    * This function is called, whenever a local variable is
 179    * used before definition. The function should insert a default value,
 180    * and/or raise a compiler error/warning. Note that returning
 181    * an Unknown is allowed here.
 182    */
 183   uninitialized_local_variable_func_t *initialize_local_func;
 184
 185   /**
 186    * The interface functions for the type identification module.
 187    * If not set, the default implementation with compare_strict() and
 188    * firm_hash_name() will be used.
 189    */
 190   type_identify_if_t *ti_if;
 191
 192   /**
 193    * The interface for the ident module.
 194    * If not set, the default libFirm ident module (using hash sets).
 195    */
 196   ident_if_t *id_if;
 197
 198   /**
 199    * The architecture dependent opcode settings.
 200    * If not set, no architecture dependent operations will be used.
 201    */
 202   const arch_ops_info *arch_op_settings;
 203
 204   /**
 205    * The default calling convention.
 206    */
 207   unsigned cc_mask;
 208
 209   /**
 210    * The debug info that should be used for "builtin" objects.
 211    */
 212   dbg_info *builtin_dbg;
 213 };
 214
 215 typedef struct _firm_parameter_t firm_parameter_t;
 216
 217 #define libFirm_VERSION_MAJOR 1
 218 #define libFirm_VERSION_MINOR 4
 219
 220 /**
 221  * The Firm version number.
 222  */
 223 typedef struct _firm_version_t {
 224   unsigned major;
 225   unsigned minor;
 226 } firm_version_t;
 227
 228 /**
 229  * Initialize the firm library.
 230  *
 231  * Initializes the firm library.  Allocates default data structures.
 232  * Initializes configurable behavior of the library.
 233  *
 234  * @param params   A structure containing the parameters of the libFirm.
 235  *
 236  * The parameter struct may be NULL. In that case, the original FIRM behavior
 237  * is conserved.
 238  */
 239 void init_firm(const firm_parameter_t *params);
 240
 241 /**
 242  * Frees all memory occupied by the firm library.
 243  */
 244 void free_firm(void);
 245
 246 /**
 247  * Returns the libFirm version number.
 248  * If statically linked, always libFirm_VERSION_MAJOR, libFirm_VERSION_MINOR
 249  */
 250 void firm_get_version(firm_version_t *version);
 251
 252 #ifdef WITH_LIBCORE
 253 /**
 254  * Read initializations arguments from the .init file.
 255  */
 256 void firm_init_options(const char *arg_prefix, int argc, const char **argv);
 257 #endif
 258
 259 #ifdef __cplusplus
 260 }
 261 #endif
 262
 263 #endif