* @file
* @brief Generic backend types and interfaces.
* @author Sebastian Hack
- * @version $Id$
*/
#ifndef FIRM_BE_MAIN_H
#define FIRM_BE_MAIN_H
-#ifdef __cplusplus
-extern "C" {
-#endif
-
#include <stdio.h>
#include "irarch.h"
-#include "archop.h"
#include "lowering.h"
+#include "iroptimize.h"
+#include "begin.h"
+
+/**
+ * @defgroup be Code Generation
+ *
+ * Code Generation (backend) produces machine-code.
+ * @{
+ */
-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
+/**
+ * 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)
+
+/**
+ * Build a Trampoline for the closure.
+ * @param block the block where to build the trampoline
+ * @param mem memory
+ * @param trampoline address of a trampoline region
+ * @param env address of the environment
+ * @param callee address of the function to call
+ *
+ * @return modified memory
+ */
+typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
/**
* This structure contains parameters that should be
* propagated to the libFirm parameter set.
*/
typedef struct backend_params {
- /** If set, the backend cannot handle DWORD access. */
- unsigned do_dw_lowering:1;
/** If set, the backend supports inline assembly. */
unsigned support_inline_asm:1;
- /** If set, the target architecture use an immediate floating point mode. */
- unsigned has_imm_fp_mode:1;
-
- /** Additional opcodes settings. */
- const arch_ops_info *arch_op_settings;
+ /** If set, the backend supports Rotl nodes */
+ unsigned support_rotl:1;
+ /** 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;
- /** The architecture specific intrinsic function creator. */
- create_intrinsic_fkt *arch_create_intrinsic_fkt;
+ /** Backend settings for if-conversion. */
+ arch_allow_ifconv_func allow_ifconv;
- /** The context parameter for the create intrinsic function. */
- void *create_intrinsic_ctx;
+ /** size of machine words. This is usually the size of the general purpose
+ * integer registers. */
+ unsigned machine_size;
- /** Backend settings for if-conversion. */
- const ir_settings_if_conv_t *if_conv_info;
+ /**
+ * some backends like x87 can only do arithmetic in a specific float
+ * mode (load/store are still done in the "normal" float/double modes).
+ */
+ ir_mode *mode_float_arithmetic;
- /** The immediate floating point mode. Temporaries are calculated using
- * this mode. */
- ir_mode *imm_fp_mode;
-} backend_params;
+ /**
+ * type used for long long or NULL if none available.
+ */
+ ir_type *type_long_long;
-/**
- * Register the Firm backend command line options.
- */
-void be_opt_register(void);
+ /**
+ * 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;
+
+ /** Alignment of the trampoline code. */
+ unsigned trampoline_align;
+
+ /** If non-zero, build the trampoline. */
+ create_trampoline_fkt *build_trampoline;
+
+ /** Alignment of stack parameters */
+ unsigned stack_param_align;
+} backend_params;
/**
* Parse one backend argument.
*/
-int be_parse_arg(const char *arg);
+FIRM_API int be_parse_arg(const char *arg);
/**
- * Return the backend configuration parameter.
+ * Returns the backend configuration parameter.
*
* @return libFirm configuration parameters for the selected
* backend
*/
-const backend_params *be_get_backend_param(void);
+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 ir_prog_pass_t *lower_for_target_pass(const char *name);
/**
* Main interface to the frontend.
*/
-void be_main(FILE *output, const char *compilation_unit_name);
+FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
/**
* parse assembler constraint strings and returns flags (so the frontend knows
* which operands are inputs/outputs and whether memory is required)
*/
-asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
+FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
/**
* tests whether a string is a valid clobber in an ASM instruction
*/
-int be_is_valid_clobber(const char *clobber);
+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;
+/** @} */
-#ifdef __cplusplus
-}
-#endif
+#include "end.h"
#endif