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 #include "scalar_replace.h" /* Scalar replacement */
  82 #include "proc_cloning.h"   /* procedure cloning */
  83 //#include "opt_branches.h"   /* Branch optimizations */
  84
  85 /* Analyses */
  86 #include "irouts.h"         /* Graph reversal / out edges. */
  87 #include "trouts.h"         /* Graph reversal / out edges for types. */
  88 #include "irdom.h"          /* Dominator analysis */
  89 #include "cgana.h"          /* Analysis to construct interprocedural graph */
  90                             /* including some optimizations */
  91 #include "irloop.h"         /* loop and backedge analysis */
  92 #include "callgraph.h"      /* Callgraph construction */
  93 #include "irconsconfirm.h"  /* Confirm nodes */
  94 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
  95 #include "interval_analysis.h"
  96 #include "field_temperature.h"
  97 #include "execution_frequency.h"
  98
  99 /* Support */
 100 #include "irgmod.h"         /* Support to modify ir */
 101 #include "irgwalk.h"        /* Support to walk ir */
 102 #include "typewalk.h"       /* Support to walk type information */
 103 #include "typegmod.h"       /* Support to modify type graph */
 104 #include "type_identify.h"  /* Support for type identification */
 105 #include "mangle.h"         /* Support for mangling ident names. */
 106 #include "tr_inheritance.h" /* Support to handle inheritance. */
 107
 108 #include "irarch.h"        /* architecture dependent optimizations */
 109 #include "archop.h"        /* architecture dependent opcodes */
 110 //#include "modeconv.h"      /* architecture dependent mode conversion */
 111
 112 #include "firmstat.h"      /* statistics */
 113
 114 #include "irreflect.h"     /* reflection */
 115
 116 #include "seqnumbers.h"    /* debug support */
 117
 118
 119 /* @@@ temporarily for jni builder until preprocessor works.
 120    Then it should be sufficient to include <file.h> instead
 121    of firm.h as not all enums are needed in the implementation
 122    files. */
 123 #include "irdump.h"
 124 #include "irprintf.h"
 125 #include "irvrfy.h"
 126 #include "trvrfy.h"
 127
 128 #include "irarch.h"
 129
 130 #include "iredges.h"
 131
 132 /* Macros that define the old function names we decided to rename.
 133    Use for compatibility with old implementations. */
 134 /*#include "old_fctnames.h"*/
 135
 136 /**
 137  * libFirm initialization parameters.
 138  */
 139 struct _firm_parameter_t {
 140   /**
 141    * The size of this structure. init_firm() will only initialize
 142    * this amount of data. This allows to add more fields to this structure
 143    * without breaking compatibility to older source.
 144    */
 145   unsigned int size;
 146
 147   /**
 148    * Statistic options. If statistic function where enabled, these
 149    * flags configure it, see enum firmstat_options_t.
 150    */
 151   unsigned enable_statistics;
 152
 153   /**
 154    * This function is called, whenever a local variable is
 155    * used before definition. The function should insert a default value,
 156    * and/or raise a compiler error/warning. Note that returning
 157    * an Unknown is allowed here.
 158    */
 159   uninitialized_local_variable_func_t *initialize_local_func;
 160
 161   /**
 162    * The interface functions for the type identification module.
 163    * If not set, the default implementation with compare_strict() and
 164    * firm_hash_name() will be used.
 165    */
 166   type_identify_if_t *ti_if;
 167
 168   /**
 169    * The interface for the ident module.
 170    * If not set, the default libFirm ident module (using hash sets).
 171    */
 172   ident_if_t *id_if;
 173
 174   /**
 175    * The architecture dependent opcode settings.
 176    * If not set, no architecture dependent operations will be used.
 177    */
 178   arch_ops_info *arch_op_settings;
 179
 180   /**
 181    * The default calling convention.
 182    */
 183   unsigned cc_mask;
 184
 185   /**
 186    * The debug info that should be used for "builtin" objects.
 187    */
 188   dbg_info *builtin_dbg;
 189
 190         /**
 191          * Prefix for the command line options.
 192          * example: if the option is -ffirm-opt-bla, then the prefix is "-f"
 193          * @note Only active, if libfirm is compiled with libcore.
 194          */
 195         const char *arg_prefix;
 196
 197         /**
 198          * Number of arguments in the "command line".
 199          * @note Only active, if libfirm is compiled with libcore.
 200          */
 201         int argc;
 202
 203         /**
 204          * Array of arguments.
 205          * @note Only active, if libfirm is compiled with libcore.
 206          */
 207         const char **argv;
 208
 209         /**
 210          * Name of ini file which is initially read.
 211          * @note Only active, if libfirm is compiled with libcore.
 212          */
 213         const char *ini_file;
 214 };
 215
 216 typedef struct _firm_parameter_t firm_parameter_t;
 217
 218 /**
 219  * Initialize the firm library.
 220  *
 221  * Initializes the firm library.  Allocates default data structures.
 222  * Initializes configurable behavior of the library.
 223  *
 224  * @param params   A structure containing the parameters of the libFirm.
 225  *
 226  * The parameter struct may be NULL. In that case, the original FIRM behavior
 227  * is conserved.
 228  */
 229 void init_firm(const firm_parameter_t *params);
 230
 231 /**
 232  * Frees all memory occupied by the firm library.
 233  */
 234 void free_firm(void);
 235
 236 #ifdef __cplusplus
 237 }
 238 #endif
 239
 240 #endif /* _FIRM_H_ */