/*
- * Copyright (C) 1995-2008 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.
+ * Copyright (C) 2012 University of Karlsruhe.
*/
/**
* @file
* @brief Generic backend types and interfaces.
* @author Sebastian Hack
- * @version $Id$
*/
#ifndef FIRM_BE_MAIN_H
#define FIRM_BE_MAIN_H
#include "iroptimize.h"
#include "begin.h"
-typedef enum {
- ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER = 0x0001,
- ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP = 0x0002,
- ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE = 0x0004,
- ASM_CONSTRAINT_FLAG_NO_SUPPORT = 0x0008,
- ASM_CONSTRAINT_FLAG_MODIFIER_WRITE = 0x0010,
- ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE = 0x0020,
- ASM_CONSTRAINT_FLAG_MODIFIER_READ = 0x0040,
- ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ = 0x0080,
- ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 0x0100,
- ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE = 0x0200,
- ASM_CONSTRAINT_FLAG_INVALID = 0x8000
+/**
+ * @defgroup be Code Generation
+ *
+ * Code Generation (backend) produces machine-code.
+ * @{
+ */
+
+/**
+ * flags categorizing assembler constraint specifications
+ */
+typedef enum asm_constraint_flags_t {
+ ASM_CONSTRAINT_FLAG_NONE = 0, /**< no constraints */
+ /** input/output can be in a register */
+ ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER = 1u << 0,
+ /** input/output can be read/written to/from a memory address */
+ ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP = 1u << 1,
+ /** input can be encoded as an immediate number */
+ ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE = 1u << 2,
+ /** the constraint is not supported yet by libFirm */
+ ASM_CONSTRAINT_FLAG_NO_SUPPORT = 1u << 3,
+ /** The input is also written to */
+ ASM_CONSTRAINT_FLAG_MODIFIER_WRITE = 1u << 4,
+ /** the input is not written to */
+ ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE = 1u << 5,
+ /** the input is read */
+ ASM_CONSTRAINT_FLAG_MODIFIER_READ = 1u << 6,
+ /** the input is not read */
+ ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ = 1u << 7,
+ /** the value is modified before all inputs to the asm block
+ * are handled. */
+ ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
+ /** This operand and the following operand are commutative */
+ ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE = 1u << 9,
+ /** invalid constraint (due to parse error) */
+ ASM_CONSTRAINT_FLAG_INVALID = 1u << 10
} asm_constraint_flags_t;
+ENUM_BITSET(asm_constraint_flags_t)
+
+/** Dwarf source language codes. */
+typedef enum {
+ DW_LANG_C89 = 0x0001,
+ DW_LANG_C = 0x0002,
+ DW_LANG_Ada83 = 0x0003,
+ DW_LANG_C_plus_plus = 0x0004,
+ DW_LANG_Cobol74 = 0x0005,
+ DW_LANG_Cobol85 = 0x0006,
+ DW_LANG_Fortran77 = 0x0007,
+ DW_LANG_Fortran90 = 0x0008,
+ DW_LANG_Pascal83 = 0x0009,
+ DW_LANG_Modula2 = 0x000a,
+ DW_LANG_Java = 0x000b,
+ DW_LANG_C99 = 0x000c,
+ DW_LANG_Ada95 = 0x000d,
+ DW_LANG_Fortran95 = 0x000e,
+ DW_LANG_PLI = 0x000f,
+ DW_LANG_ObjC = 0x0010,
+ DW_LANG_ObjC_plus_plus = 0x0011,
+ DW_LANG_UPC = 0x0012,
+ DW_LANG_D = 0x0013,
+ DW_LANG_Python = 0x0014,
+ DW_LANG_Go = 0x0016,
+} dwarf_source_language;
/**
* Build a Trampoline for the closure.
*/
typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
-/** callback where the backend performs required lowering for the target
- * architecture. Typical examples are transforming doubleword operations into
- * sequences of word operations. The callback should be invoked before the
- * frontend, because it is usually a good idea to perform other optimisations
- * after the lowering
- */
-typedef void (*lower_for_target_func)(void);
-
/**
* This structure contains parameters that should be
* propagated to the libFirm parameter set.
unsigned support_inline_asm:1;
/** If set, the backend supports Rotl nodes */
unsigned support_rotl:1;
-
- /** callback that performs lowerings required for target architecture */
- lower_for_target_func lower_for_target;
+ /** the backend uses big-endian byte ordering if set, else little endian */
+ unsigned byte_order_big_endian:1;
+ /** whether the architecure can natively handle modulo shift modes.
+ * If this is true, then you can assume that shifting in modes with
+ * module_shift==machine_size (if mode size is <= machine_size) is efficient
+ */
+ unsigned modulo_shift_efficient:1;
+ /** whether the architecure can natively handle modulo shift modes.
+ * If this is true, then you can assume that shifting without modulo shift
+ * is efficient
+ */
+ unsigned non_modulo_shift_efficient:1;
/** Settings for architecture dependent optimizations. */
const ir_settings_arch_dep_t *dep_param;
/** Backend settings for if-conversion. */
arch_allow_ifconv_func allow_ifconv;
+ /** size of machine word in bits. This is usually the size of the general
+ * purpose integer/address registers. */
+ unsigned machine_size;
+
/**
* some backends like x87 can only do arithmetic in a specific float
- * mode (but convert to/from other float modes).
+ * mode (load/store are still done in the "normal" float/double modes).
*/
ir_mode *mode_float_arithmetic;
+ /**
+ * type used for long long or NULL if none available.
+ */
+ ir_type *type_long_long;
+
+ /**
+ * type used for unsigned long long or NULL if none available
+ */
+ ir_type *type_unsigned_long_long;
+
+ /**
+ * type used for long double or NULL if none available.
+ */
+ ir_type *type_long_double;
+
/** Size of the trampoline code. */
unsigned trampoline_size;
} backend_params;
/**
- * Register the Firm backend command line options.
+ * Parse one backend argument.
*/
-FIRM_API void be_opt_register(void);
+FIRM_API int be_parse_arg(const char *arg);
/**
- * Parse one backend argument.
+ * Returns 1 if the backend uses big-endian byte ordering
+ * and 0 for little-endian.
*/
-FIRM_API int be_parse_arg(const char *arg);
+FIRM_API int be_is_big_endian(void);
/**
- * Return the backend configuration parameter.
+ * Returns size of machine words. This is usually the size
+ * of the general purpose integer registers.
+ */
+FIRM_API unsigned be_get_machine_size(void);
+
+/**
+ * Returns supported float arithmetic mode or NULL if mode_D and mode_F
+ * are supported natively.
+ * Some backends like x87 can only do arithmetic in a specific float
+ * mode (load/store are still done in the "normal" float/double modes).
+ */
+FIRM_API ir_mode *be_get_mode_float_arithmetic(void);
+
+/** Returns type used for long long or NULL if none available. */
+FIRM_API ir_type *be_get_type_long_long(void);
+
+/** Returns type used for unsigned long long or NULL if none available. */
+FIRM_API ir_type *be_get_type_unsigned_long_long(void);
+
+/** Returns type used for long double or NULL if none available. */
+FIRM_API ir_type *be_get_type_long_double(void);
+
+/**
+ * Returns the backend configuration parameter.
*
* @return libFirm configuration parameters for the selected
* backend
*/
FIRM_API const backend_params *be_get_backend_param(void);
+/**
+ * Lowers current program for the target architecture.
+ * This must be run once before using be_main. The idea here is that the backend
+ * can perform lowerings like doubleword-lowering, ABI adjustments or
+ * implementation of boolean values, if-conversion, with target specific
+ * settings.
+ * The resulting graph is still a "normal" firm-graph on which you can and
+ * should perform further architecture-neutral optimisations before be_main.
+ */
+FIRM_API void be_lower_for_target(void);
+
/**
* Creates an ir_prog pass which performs lowerings necessary for the target
* architecture. (Calling backend_params->lower_for_target)
*/
FIRM_API int be_is_valid_clobber(const char *clobber);
-typedef struct be_main_env_t be_main_env_t;
-typedef struct be_options_t be_options_t;
+/**
+ * Sets source language for dwarf debug information.
+ */
+FIRM_API void be_dwarf_set_source_language(dwarf_source_language language);
+
+/**
+ * Sets working directory of the compiler (or directory where the compiler
+ * searched for sources) for dwarf debug information.
+ */
+FIRM_API void be_dwarf_set_compilation_directory(const char *directory);
+
+/** @} */
#include "end.h"