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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/common/firm.h
   4  * Purpose:     Central firm header.
   5  * Author:      Martin Trapp, Christian Schaefer
   6  * Modified by: Goetz Lindenmaier
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /**
  14  * @file firm.h
  15  *
  16  *  Central FIRM header.
  17  *
  18  *  FIRM is a full graph based intermediate representation in SSA Form
  19  *  with a novel concept to model side effects.  It allows fast, aggressive
  20  *  optimizations.
  21  *
  22  *  This header is the central header of the library implementation of this
  23  *  IR.
  24  *
  25  *  The internal representation of a program in firm is separated into five
  26  *  different modules:
  27  *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
  28  *     Firm Graphs are assembled out of several data structures:
  29  *     irprog: represents a program.  Allows access to all types and all
  30  *       FIRM graphs for procedures and other global things.
  31  *     irgraph: represents a procedure.  Allows access to the code of the
  32  *       procedure, the actual FIRM graph.
  33  *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
  34  *   and represent instructions in a program.
  35  *     irop: The opcode of FIRM nodes.
  36  *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
  37  *       data types (int, float, pointer).
  38  *   - Entities representing program known objects. (Subdirectory tr.)
  39  *     All variables and procedures are entities.
  40  *   - Types describing the type system for the program. (Subdirectory tr.)
  41  *   - Target Values representing program known constants. (Subdirectory tv.)
  42  *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
  43  *
  44  *   Further this library supplies functionality to build and optimize FIRM graphs
  45  *   and further functionality needed in a compiler.  Finally there is more
  46  *   generic functionality to support implementations using firm.  (Code generation,
  47  *   further optimizations).
  48  */
  49 #ifndef _FIRM_H_
  50 #define _FIRM_H_
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 /* The representations */
  57 #include "firm_common.h"   /* common type tags. */
  58 #include "irprog.h"        /* control flow and data of a program */
  59 #include "type.h"          /* type representation */
  60 #include "entity.h"        /* entity representation */
  61 #include "tv.h"            /* target values */
  62 #include "ident.h"         /* source code identificators */
  63
  64 /* Functionality */
  65 #include "ircons.h"        /* construct ir */
  66 #include "ircgcons.h"      /* construct interprocedural graph */
  67
  68 /* Optimizations */
  69 #include "irflag.h"         /* optimization flags */
  70 #include "irgopt.h"         /* optimize ir */
  71 #include "reassoc.h"        /* optimize ir by reassociation */
  72 #include "ldstopt.h"        /* optimize Load/Store */
  73 #include "cfopt.h"          /* optimize control flow */
  74 #include "tailrec.h"        /* optimize tail-recursion calls */
  75 #include "ircgopt.h"        /* Optimizations based on interprocedural graph */
  76 #include "strength_red.h"   /* Strength reduction */
  77 #include "loop_unrolling.h" /* Do loop unrolling */
  78 #include "ifconv.h"         /* if conversion */
  79 #include "funccall.h"       /* real function call optimization */
  80 #include "return.h"         /* Return node normalizations */
  81
  82 /* Analyses */
  83 #include "irouts.h"         /* Graph reversal / out edges. */
  84 #include "irdom.h"          /* Dominator analysis */
  85 #include "cgana.h"          /* Analysis to construct interprocedural graph */
  86                             /* including some optimizations */
  87 #include "irloop.h"         /* loop and backedge analysis */
  88 #include "callgraph.h"      /* Callgraph construction */
  89 #include "interval_analysis.h"
  90 #include "field_temperature.h"
  91 #include "execution_frequency.h"
  92
  93 /* Support */
  94 #include "irgmod.h"         /* Support to modify ir */
  95 #include "irgwalk.h"        /* Support to walk ir */
  96 #include "typewalk.h"       /* Support to walk type information */
  97 #include "typegmod.h"       /* Support to modify type graph */
  98 #include "type_identify.h"  /* Support for type identification */
  99 #include "mangle.h"         /* Support for mangling ident names. */
 100 #include "tr_inheritance.h" /* Support to handle inheritance. */
 101
 102 #include "irarch.h"        /* architecture dependant optimizations */
 103 #include "archop.h"        /* architecture dependant opcodes */
 104 //#include "modeconv.h"      /* architecture dependant mode conversion */
 105
 106 #include "firmstat.h"      /* statistics */
 107
 108 #include "irreflect.h"     /* reflection */
 109
 110
 111 /* @@@ temporarily for jni builder until preprocessor works.
 112    Then it should be sufficient to include <file.h> instead
 113    of firm.h as not all enums are needed in the implementation
 114    files. */
 115 #include "irdump.h"
 116 #include "irprintf.h"
 117 #include "irvrfy.h"
 118 #include "trvrfy.h"
 119
 120 #include "irarch.h"
 121
 122 #include "iredges.h"
 123
 124 /* Makros that define the old function names we decided to rename.
 125    Use for compatibility with old implementations. */
 126 /*#include "old_fctnames.h"*/
 127
 128 /**
 129  * libFirm initialization parameters.
 130  */
 131 struct _firm_parameter_t {
 132   /**
 133    * The size of this structure. init_firm() will only initialize
 134    * this amount of data. This allows to add more fields to this structure
 135    * without breaking compatibility to older source.
 136    */
 137   unsigned int size;
 138
 139   /**
 140    * Statistic options. If statistic function where enabled, these
 141    * flags configure it, see enum firmstat_options_t.
 142    */
 143   unsigned enable_statistics;
 144
 145   /**
 146    * This function is called, whenever a local variable is
 147    * used before definition.  The function should either insert a default value,
 148    * or raise a compiler error/warning.
 149    */
 150   uninitialized_local_variable_func_t *initialize_local_func;
 151
 152   /**
 153    * The interface functions for the type identification module.
 154    * If not set, the default implementation with compare_strict() and
 155    * firm_hash_name() will be used.
 156    */
 157   type_identify_if_t *ti_if;
 158
 159   /**
 160    * The interface for the ident module.
 161    * If not set, the default libFirm ident module (using hash sets).
 162    */
 163   ident_if_t *id_if;
 164
 165   /**
 166    * The architecture dependand opcode settings.
 167    * If not set, no architecture dependand operations will be used.
 168    */
 169   arch_ops_info *arch_op_settings;
 170 };
 171
 172 typedef struct _firm_parameter_t firm_parameter_t;
 173
 174 /**
 175  * Initialize the firm library.
 176  *
 177  * Initializes the firm library.  Allocates default data structures.
 178  * Initializes configurable behaviour of the library.
 179  *
 180  * @param param    A structure containing the parameters of the libFirm.
 181  *
 182  * The parameter struct may be NULL. In that case, the original FIRM behavior
 183  * is conserved.
 184  */
 185 void init_firm(const firm_parameter_t *params);
 186
 187 /**
 188  * Frees all memory occupied by the firm library.
 189  */
 190 void free_firm(void);
 191
 192 #ifdef __cplusplus
 193 }
 194 #endif
 195
 196 #endif /* _FIRM_H_ */