/*
- * Project: libFIRM
- * File name: ir/common/firm.h
- * Purpose: Central firm header.
- * Author: Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier
- * Created:
- * CVS-ID: $Id$
- * Copyright: (c) 1998-2003 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
*/
/**
- * @file firm.h
- *
+ * @file
+ * @brief Central firm header.
+ * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
+ * @version $Id$
+ * @summary
* Central FIRM header.
*
* FIRM is a full graph based intermediate representation in SSA Form
* generic functionality to support implementations using firm. (Code generation,
* further optimizations).
*/
-#ifndef _FIRM_H_
-#define _FIRM_H_
+#ifndef FIRM_COMMON_FIRM_H
+#define FIRM_COMMON_FIRM_H
#ifdef __cplusplus
extern "C" {
/* The representations */
#include "firm_common.h" /* common type tags. */
#include "irprog.h" /* control flow and data of a program */
+#include "irgraph.h" /* graphs */
#include "type.h" /* type representation */
#include "entity.h" /* entity representation */
#include "tv.h" /* target values */
#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 "opt_osr.h" /* Operator Strength Reduction */
+#include "strength_red.h" /* Old (and buggy) 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 */
+#include "scalar_replace.h" /* Scalar replacement */
+#include "proc_cloning.h" /* procedure cloning */
+#include "opt_confirms.h" /* Confirm based optimizations */
+#include "gvn_pre.h" /* global value numbering and partial redundancy elimination */
+#include "opt_frame.h" /* frame type optimization */
+#include "tropt.h" /* optimize the type representation */
+#include "condeval.h" /* control flow optimization by conditional evaluation */
+
+/* Lowering */
+#include "lower_calls.h" /* lowering of different calls */
+#include "lower_intrinsics.h" /* lowering of intrinsic calls */
+#include "lower_dw.h" /* double word types lowering */
+#include "lower_hl.h" /* lowering of high-level constructs */
/* 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 "irouts.h" /* Graph reversal / out edges. */
+#include "trouts.h" /* Graph reversal / out edges for types. */
+#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 "irconsconfirm.h" /* Confirm nodes */
+#include "analyze_irg_args.h" /* Simple pointer parameter analysis */
+#include "irtypeinfo.h" /* type information for nodes */
+#include "irmemory.h" /* memory disambiguation */
#include "interval_analysis.h"
#include "field_temperature.h"
#include "execution_frequency.h"
#include "mangle.h" /* Support for mangling ident names. */
#include "tr_inheritance.h" /* Support to handle inheritance. */
-#include "irarch.h" /* architecture dependant optimizations */
-#include "archop.h" /* architecture dependant opcodes */
-//#include "modeconv.h" /* architecture dependant mode conversion */
+#include "irarch.h" /* architecture dependent optimizations */
+#include "archop.h" /* architecture dependent opcodes */
+//#include "modeconv.h" /* architecture dependent mode conversion */
#include "firmstat.h" /* statistics */
#include "irreflect.h" /* reflection */
+#include "seqnumbers.h" /* debug support */
+#include "firm_ycomp.h" /* ycomp debugging support */
+
/* @@@ temporarily for jni builder until preprocessor works.
Then it should be sufficient to include <file.h> instead
#include "iredges.h"
-/* Makros that define the old function names we decided to rename.
+/* Macros that define the old function names we decided to rename.
Use for compatibility with old implementations. */
/*#include "old_fctnames.h"*/
/**
* This function is called, whenever a local variable is
- * used before definition. The function should either insert a default value,
- * or raise a compiler error/warning.
+ * used before definition. The function should insert a default value,
+ * and/or raise a compiler error/warning. Note that returning
+ * an Unknown is allowed here.
*/
uninitialized_local_variable_func_t *initialize_local_func;
ident_if_t *id_if;
/**
- * The architecture dependand opcode settings.
- * If not set, no architecture dependand operations will be used.
+ * The architecture dependent opcode settings.
+ * If not set, no architecture dependent operations will be used.
+ */
+ const arch_ops_info *arch_op_settings;
+
+ /**
+ * The default calling convention.
+ */
+ unsigned cc_mask;
+
+ /**
+ * The debug info that should be used for "builtin" objects.
*/
- arch_ops_info *arch_op_settings;
+ dbg_info *builtin_dbg;
};
typedef struct _firm_parameter_t firm_parameter_t;
+#define libFirm_VERSION_MAJOR 1
+#define libFirm_VERSION_MINOR 4
+
+/**
+ * The Firm version number.
+ */
+typedef struct _firm_version_t {
+ unsigned major;
+ unsigned minor;
+} firm_version_t;
+
/**
* Initialize the firm library.
*
* Initializes the firm library. Allocates default data structures.
- * Initializes configurable behaviour of the library.
+ * Initializes configurable behavior of the library.
*
- * @param param A structure containing the parameters of the libFirm.
+ * @param params A structure containing the parameters of the libFirm.
*
* The parameter struct may be NULL. In that case, the original FIRM behavior
* is conserved.
*/
void free_firm(void);
+/**
+ * Returns the libFirm version number.
+ * If statically linked, always libFirm_VERSION_MAJOR, libFirm_VERSION_MINOR
+ */
+void firm_get_version(firm_version_t *version);
+
+#ifdef WITH_LIBCORE
+/**
+ * Read initializations arguments from the .init file.
+ */
+void firm_init_options(const char *arg_prefix, int argc, const char **argv);
+#endif
+
#ifdef __cplusplus
}
#endif
-#endif /* _FIRM_H_ */
+#endif