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  This documentation no more  maintained since 2001!!!
  17
  18     Central FIRM header.
  19
  20     FIRM is a full graph based intermediate representation in SSA Form
  21     with a novel concept to model side effects.  It allows fast, aggressive
  22     optimizations.
  23
  24     This header is the central header of the library implementation of this
  25     IR.
  26
  27     The internal representation of a program in firm is separated into five
  28     different modules:
  29      - Firm Graphs representing the code of a program. (Subdirectory ir.)
  30        Firm Graphs are assembled out of several data structures:
  31        irprog: represents a program.  Allows access to all types and all
  32          FIRM graphs for procedures and other global things.
  33        irgraph: represents a procedure.  Allows access to the code of the
  34          procedure, the actual FIRM graph.
  35        irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
  36      and represent instructions in a program.
  37        irop: The opcode of FIRM nodes.
  38        irmode: The mode of FIRM nodes.  Most modes correspond to machine known
  39          data types (int, float, pointer).
  40      - Entities representing program known objects. (Subdirectory tr.)
  41        All variables and procedures are entities.
  42      - Types describing the type system for the program. (Subdirectory tr.)
  43      - Target Values representing program known constants. (Subdirectory tv.)
  44      - Identifiers representing any Strings used in the program. (Subdirectory ident.)
  45
  46      Further this library supplies functionality to build and optimize FIRM graphs
  47      and further functionality needed in a compiler.  Finally there is more
  48      generic functionality to support implementations using firm.  (Code generation,
  49      further optimizations).
  50
  51      ircons: Interface to construct firm graphs, implements automatic Phi node
  52        construction.
  53      iropt: Optimizations applied to individual nodes.
  54      irgopt: Optimizations for ir graphs.
  55
  56      irflag: Flags to direct the functionality.
  57      common: dynamic typ check for all nodes,  configuration of the library,
  58      debug:  ???
  59
  60      irgwalk: walker for ir graphs.
  61      irvrfy:  verify the correctness of a firm node.
  62 *
  63 */
  64
  65 #ifndef _FIRM_H_
  66 #define _FIRM_H_
  67
  68 #ifdef __cplusplus
  69 extern "C" {
  70 #endif
  71
  72 #include "old_fctnames.h"
  73
  74 /* The representations */
  75 #include "firm_common.h"   /* common type tags. */
  76 #include "irprog.h"        /* control flow and data of a program */
  77 #include "type.h"          /* type representation */
  78 #include "entity.h"        /* entity representation */
  79 #include "tv.h"            /* target values */
  80 #include "ident.h"         /* source code identificators */
  81 /* Functionality */
  82 #include "ircons.h"        /* construct ir */
  83 #include "ircgcons.h"      /* construct interprocedural graph */
  84
  85 #include "irflag.h"        /* optimization flags */
  86 #include "irgopt.h"        /* optimize ir */
  87 #include "tailrec.h"       /* optimize tail-recursion calls */
  88 #include "ircgopt.h"       /* Optimizations based on interprocedural graph */
  89
  90 #include "irouts.h"        /* Graph reversal / out edges. */
  91 #include "irdom.h"         /* Dominator analysis */
  92 #include "cgana.h"         /* Analysis to construct interprocedural graph
  93                               including some optimizations */
  94 #include "irloop.h"        /* loop and backedge analysis */
  95
  96 #include "irgmod.h"        /* Support to modify ir */
  97 #include "irgwalk.h"       /* Support to walk ir */
  98 #include "typewalk.h"      /* Support to walk type information */
  99 #include "typegmod.h"      /* Support to modify type graph */
 100 #include "type_identify.h" /* Support for type identification */
 101 #include "mangle.h"        /* Support for mangling ident names. */
 102
 103 #include "firmstat.h"      /* statistics */
 104
 105 /* @@@ temporarily for jni builder until preprocessor works.
 106    Then it should be sufficient to include <file.h> instead
 107    of firm.h as not all enums are needed in the implementation
 108    files. */
 109 #include "irdump.h"
 110 #include "irvrfy.h"
 111 #include "trvrfy.h"
 112
 113 /**
 114  * libFirm initialization parameters.
 115  */
 116 typedef struct _firm_parameter_t {
 117   /**
 118    * The size of this structure. init_firm() will only initialize
 119    * this amount of data. This allows to add more fields to this structure
 120    * without breaking compatibility to older source
 121    */
 122   unsigned int size;
 123
 124   /**
 125    * Statistic options. If statistic function where enabled, these
 126    * flags configure it, see enum firmstat_options_t.
 127    */
 128   unsigned enable_statistics;
 129
 130   /**
 131    * This function is called, whenever a local variable is
 132    * used before definition.  The function should either insert a default value,
 133    * or raise a compiler error/warning.
 134    */
 135   default_initialize_local_variable_func_t *initialize_local_func;
 136
 137   /**
 138    * The compare function is used to identify equal types.  If not set
 139    * it is initialized with the function compare_strict().
 140    */
 141   compare_types_func_t                     *compare_types_func;
 142   /**
 143    * The hash function is used to identify equal types.  It calculates a hash
 144    * value of a type. Note, that the hash value for equal types must be identical.
 145    * If not set it is initialized with the function hash_name().
 146    */
 147   hash_types_func_t                        *hash_types_func;
 148
 149 } firm_parameter_t;
 150
 151 /**
 152  * Initialize the firm library.
 153  *
 154  * Initializes the firm library.  Allocates default data structures.
 155  * Initializes configurable behaviour of the library.
 156  *
 157  * @param param    This function is called, whenever a local variable is
 158  * used before definition.  The function should either insert a default value,
 159  * or raise a compiler error.
 160  *
 161  * The parameter func may be NULL. In that case, the original FIRM behavior
 162  * is conserved.
 163  *
 164  * @see default_initialize_local_variable_func_t
 165  */
 166 void init_firm(const firm_parameter_t *params);
 167
 168 /**
 169  * Frees all memory occupied by the firm library.
 170  */
 171 void free_firm(void);
 172
 173 #ifdef __cplusplus
 174 }
 175 #endif
 176
 177 #endif /* _FIRM_H_ */