X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fcommon%2Ffirm.h;h=81475e28b6feba70f10ebf0bfa3d855c6964e17a;hb=2e3826ef502d31da98bb9679df02555d121194d9;hp=fd8ef54f7b26d55d0eda93636fd4ef8192b00fd8;hpb=04e3bb77b2138166bfe936d1eccf813fdfef3b7f;p=libfirm diff --git a/ir/common/firm.h b/ir/common/firm.h index fd8ef54f7..81475e28b 100644 --- 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_ @@ -76,46 +60,69 @@ extern "C" { #include "entity.h" /* entity representation */ #include "tv.h" /* target values */ #include "ident.h" /* source code identificators */ + /* Functionality */ #include "ircons.h" /* construct ir */ #include "ircgcons.h" /* construct interprocedural graph */ -#include "irflag.h" /* optimization flags */ -#include "irgopt.h" /* optimize ir */ -#include "ldstopt.h" /* optimize Load/Store */ -#include "cfopt.h" /* optimize control flow */ -#include "tailrec.h" /* optimize tail-recursion calls */ -#include "ircgopt.h" /* Optimizations based on interprocedural graph */ - -#include "irouts.h" /* Graph reversal / out edges. */ -#include "irdom.h" /* Dominator analysis */ -#include "cgana.h" /* Analysis to construct interprocedural graph */ - /* including some optimizations */ -#include "irloop.h" /* loop and backedge analysis */ -#include "callgraph.h" /* Callgraph construction */ - -#include "irgmod.h" /* Support to modify ir */ -#include "irgwalk.h" /* Support to walk ir */ -#include "typewalk.h" /* Support to walk type information */ -#include "typegmod.h" /* Support to modify type graph */ -#include "type_identify.h" /* Support for type identification */ -#include "mangle.h" /* Support for mangling ident names. */ +/* Optimizations */ +#include "irflag.h" /* optimization flags */ +#include "irgopt.h" /* optimize ir */ +#include "reassoc.h" /* optimize ir by reassociation */ +#include "ldstopt.h" /* optimize Load/Store */ +#include "cfopt.h" /* optimize control flow */ +#include "tailrec.h" /* optimize tail-recursion calls */ +#include "ircgopt.h" /* Optimizations based on interprocedural graph */ +#include "strength_red.h" /* Strength reduction */ +#include "loop_unrolling.h" /* Do loop unrolling */ +#include "ifconv.h" /* if conversion */ +#include "funccall.h" /* real function call optimization */ +#include "return.h" /* Return node normalizations */ + +/* Analyses */ +#include "irouts.h" /* Graph reversal / out edges. */ +#include "irdom.h" /* Dominator analysis */ +#include "cgana.h" /* Analysis to construct interprocedural graph */ + /* including some optimizations */ +#include "irloop.h" /* loop and backedge analysis */ +#include "callgraph.h" /* Callgraph construction */ +#include "interval_analysis.h" +#include "field_temperature.h" +#include "execution_frequency.h" + +/* Support */ +#include "irgmod.h" /* Support to modify ir */ +#include "irgwalk.h" /* Support to walk ir */ +#include "typewalk.h" /* Support to walk type information */ +#include "typegmod.h" /* Support to modify type graph */ +#include "type_identify.h" /* Support for type identification */ +#include "mangle.h" /* Support for mangling ident names. */ +#include "tr_inheritance.h" /* Support to handle inheritance. */ + +#include "irarch.h" /* architecture dependant optimizations */ +//#include "modeconv.h" /* architecture dependant mode conversion */ #include "firmstat.h" /* statistics */ #include "irreflect.h" /* reflection */ + /* @@@ temporarily for jni builder until preprocessor works. Then it should be sufficient to include instead of firm.h as not all enums are needed in the implementation files. */ #include "irdump.h" +#include "irprintf.h" #include "irvrfy.h" #include "trvrfy.h" +#include "irarch.h" + +#include "iredges.h" + /* 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. @@ -139,19 +146,25 @@ 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 compare function is used to identify equal types. If not set - * it is initialized with the function compare_strict(). + * The interface functions for the type identification module. + * If not set, the default implementation with compare_strict() and + * firm_hash_name() will be used. */ - compare_types_func_t *compare_types_func; + type_identify_if_t *ti_if; + /** - * The hash function is used to identify equal types. It calculates a hash - * value of a type. Note, that the hash value for equal types must be identical. - * If not set it is initialized with the function hash_name(). + * The interface for the ident module. + * If not set, the default libFirm ident module (using hash sets). */ - hash_types_func_t *hash_types_func; + ident_if_t *id_if; + + /** + * The factory function for the architecture dependent + * optimizations. + */ };