implemented loop unrolling optimization

[libfirm] / ir / common / firm.h

diff --git a/ir/common/firm.h b/ir/common/firm.h
index f7dc8f0..b6d718a 100644 (file)
--- a/ir/common/firm.h
+++ b/ir/common/firm.h
@@ -11,57 +11,41 @@
  */
 
 /**
- @file firm.h
-
- This documentation no more  maintained since 2001!!!
-
-    Central FIRM header.
-
-    FIRM is a full graph based intermediate representation in SSA Form
-    with a novel concept to model side effects.  It allows fast, aggressive
-    optimizations.
-
-    This header is the central header of the library implementation of this
-    IR.
-
-    The internal representation of a program in firm is separated into five
-    different modules:
-     - Firm Graphs representing the code of a program. (Subdirectory ir.)
-       Firm Graphs are assembled out of several data structures:
-       irprog: represents a program.  Allows access to all types and all
-         FIRM graphs for procedures and other global things.
-       irgraph: represents a procedure.  Allows access to the code of the
-         procedure, the actual FIRM graph.
-       irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
-     and represent instructions in a program.
-       irop: The opcode of FIRM nodes.
-       irmode: The mode of FIRM nodes.  Most modes correspond to machine known
-         data types (int, float, pointer).
-     - Entities representing program known objects. (Subdirectory tr.)
-       All variables and procedures are entities.
-     - Types describing the type system for the program. (Subdirectory tr.)
-     - Target Values representing program known constants. (Subdirectory tv.)
-     - Identifiers representing any Strings used in the program. (Subdirectory ident.)
-
-     Further this library supplies functionality to build and optimize FIRM graphs
-     and further functionality needed in a compiler.  Finally there is more
-     generic functionality to support implementations using firm.  (Code generation,
-     further optimizations).
-
-     ircons: Interface to construct firm graphs, implements automatic Phi node
-       construction.
-     iropt: Optimizations applied to individual nodes.
-     irgopt: Optimizations for ir graphs.
-
-     irflag: Flags to direct the functionality.
-     common: dynamic typ check for all nodes,  configuration of the library,
-     debug:  ???
-
-     irgwalk: walker for ir graphs.
-     irvrfy:  verify the correctness of a firm node.
-*
-*/
-
+ * @file firm.h
+ *
+ *  Central FIRM header.
+ *
+ *  FIRM is a full graph based intermediate representation in SSA Form
+ *  with a novel concept to model side effects.  It allows fast, aggressive
+ *  optimizations.
+ *
+ *  This header is the central header of the library implementation of this
+ *  IR.
+ *
+ *  The internal representation of a program in firm is separated into five
+ *  different modules:
+ *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
+ *     Firm Graphs are assembled out of several data structures:
+ *     irprog: represents a program.  Allows access to all types and all
+ *       FIRM graphs for procedures and other global things.
+ *     irgraph: represents a procedure.  Allows access to the code of the
+ *       procedure, the actual FIRM graph.
+ *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
+ *   and represent instructions in a program.
+ *     irop: The opcode of FIRM nodes.
+ *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
+ *       data types (int, float, pointer).
+ *   - Entities representing program known objects. (Subdirectory tr.)
+ *     All variables and procedures are entities.
+ *   - Types describing the type system for the program. (Subdirectory tr.)
+ *   - Target Values representing program known constants. (Subdirectory tv.)
+ *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
+ *
+ *   Further this library supplies functionality to build and optimize FIRM graphs
+ *   and further functionality needed in a compiler.  Finally there is more
+ *   generic functionality to support implementations using firm.  (Code generation,
+ *   further optimizations).
+ */
 #ifndef _FIRM_H_
 #define _FIRM_H_
 
@@ -131,7 +115,7 @@ extern "C" {
 
 /* Makros that define the old function names we decided to rename.
    Use for compatibility with old implementations. */
-//#include "old_fctnames.h"
+/*#include "old_fctnames.h"*/
 
 /**
  * libFirm initialization parameters.
@@ -155,12 +139,12 @@ struct _firm_parameter_t {
    * used before definition.  The function should either insert a default value,
    * or raise a compiler error/warning.
    */
-  default_initialize_local_variable_func_t *initialize_local_func;
+  uninitialized_local_variable_func_t *initialize_local_func;
 
   /**
    * The interface functions for the type identification module.
    * If not set, the default implementation with compare_strict() and
-   * hash_name() will be used.
+   * firm_hash_name() will be used.
    */
   type_identify_if_t *ti_if;