[libfirm] / ir / be / bearch.h

/*
 * 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.
 */

/**
 * @file
 * @brief       Processor architecture specification.
 * @author      Sebastian Hack
 * @version     $Id$
 */
#ifndef FIRM_BE_BEARCH_H
#define FIRM_BE_BEARCH_H

#include <stdbool.h>

#include "firm_types.h"
#include "bitset.h"
#include "obst.h"
#include "raw_bitset.h"
#include "irop_t.h"

#include "be_types.h"
#include "beinfo.h"
#include "be.h"
#include "beirg.h"
#include "error.h"

typedef enum arch_register_class_flags_t {
        arch_register_class_flag_none      = 0,
        /** don't do automatic register allocation for this class */
        arch_register_class_flag_manual_ra = 1U << 0,
        /** the register models an abstract state (example: fpu rounding mode) */
        arch_register_class_flag_state     = 1U << 1
} arch_register_class_flags_t;
ENUM_BITSET(arch_register_class_flags_t)

typedef enum arch_register_type_t {
        arch_register_type_none         = 0,
        /** The register must be saved by the caller upon a function call. It thus
         * can be overwritten in the called function. */
        arch_register_type_caller_save  = 1U << 0,
        /** The register must be saved by the caller upon a function call. It thus
         * can be overwritten in the called function. */
        arch_register_type_callee_save  = 1U << 1,
        /** Do not consider this register when allocating. */
        arch_register_type_ignore       = 1U << 2,
        /** The emitter can choose an arbitrary register. The register fulfills any
         * register constraints as long as the register class matches */
        arch_register_type_joker        = 1U << 3,
        /** This is just a virtual register. Virtual registers fulfill any register
         * constraints as long as the register class matches. It is a allowed to
         * have multiple definitions for the same virtual register at a point */
        arch_register_type_virtual      = 1U << 4,
        /** The register represents a state that should be handled by bestate
         * code */
        arch_register_type_state        = 1U << 5,
} arch_register_type_t;
ENUM_BITSET(arch_register_type_t)

/**
 * Different types of register allocation requirements.
 */
typedef enum arch_register_req_type_t {
        /** No register requirement. */
        arch_register_req_type_none              = 0,
        /** All registers in the class are allowed. */
        arch_register_req_type_normal            = 1U << 0,
        /** Only a real subset of the class is allowed. */
        arch_register_req_type_limited           = 1U << 1,
        /** The register should be equal to another one at the node. */
        arch_register_req_type_should_be_same    = 1U << 2,
        /** The register must be unequal from some other at the node. */
        arch_register_req_type_must_be_different = 1U << 3,
        /** The registernumber should be aligned (in case of multiregister values)*/
        arch_register_req_type_aligned           = 1U << 4,
        /** ignore while allocating registers */
        arch_register_req_type_ignore            = 1U << 5,
        /** the output produces a new value for the stack pointer
         * (this is not really a constraint but a marker to guide the stackpointer
         * rewiring logic) */
        arch_register_req_type_produces_sp       = 1U << 6,
} arch_register_req_type_t;
ENUM_BITSET(arch_register_req_type_t)

extern const arch_register_req_t *arch_no_register_req;

/**
 * Print information about a register requirement in human readable form
 * @param F   output stream/file
 * @param req The requirements structure to format.
 */
void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
                            const ir_node *node);

void arch_dump_register_reqs(FILE *F, const ir_node *node);
void arch_dump_reqs_and_registers(FILE *F, const ir_node *node);

/**
 * Node classification. Used for statistics and for detecting reload nodes.
 */
typedef enum arch_irn_class_t {
        arch_irn_class_none   = 0,
        arch_irn_class_spill  = 1 << 0,
        arch_irn_class_reload = 1 << 1,
        arch_irn_class_remat  = 1 << 2,
        arch_irn_class_copy   = 1 << 3,
        arch_irn_class_perm   = 1 << 4
} arch_irn_class_t;
ENUM_BITSET(arch_irn_class_t)

void arch_set_frame_offset(ir_node *irn, int bias);

ir_entity *arch_get_frame_entity(const ir_node *irn);
int        arch_get_sp_bias(ir_node *irn);

int             arch_get_op_estimated_cost(const ir_node *irn);
arch_inverse_t *arch_get_inverse(const ir_node *irn, int i,
                                 arch_inverse_t *inverse,
                                 struct obstack *obstack);
int             arch_possible_memory_operand(const ir_node *irn,
                                             unsigned int i);
void            arch_perform_memory_operand(ir_node *irn, ir_node *spill,
                                            unsigned int i);

/**
 * Get the register requirements for a node.
 * @note Deprecated API! Preferably use
 *       arch_get_in_register_req and
 *       arch_get_out_register_req.
 *
 * @param irn The node.
 * @param pos The position of the operand you're interested in.
 * @return    A pointer to the register requirements.  If NULL is returned, the
 *            operand was no register operand.
 */
const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);

/**
 * Check, if a register is assignable to an operand of a node.
 * @param irn The node.
 * @param pos The position of the operand.
 * @param reg The register.
 * @return    1, if the register might be allocated to the operand 0 if not.
 */
int arch_reg_is_allocatable(const ir_node *irn, int pos,
                            const arch_register_t *reg);

#define arch_reg_out_is_allocatable(irn, reg) arch_reg_is_allocatable(irn, -1, reg)

/**
 * Get the register class of an operand of a node.
 * @param irn The node.
 * @param pos The position of the operand, -1 for the output.
 * @return    The register class of the operand or NULL, if
 *            operand is a non-register operand.
 */
const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn,
                                                    int pos);

#define arch_get_irn_reg_class_out(irn) arch_get_irn_reg_class(irn, -1)

/**
 * Get the register allocated at a certain output operand of a node.
 * @param irn The node.
 * @return    The register allocated for this operand
 */
const arch_register_t *arch_get_irn_register(const ir_node *irn);
const arch_register_t *arch_irn_get_register(const ir_node *irn, int pos);

/**
 * Set the register for a certain output operand.
 * @param irn The node.
 * @param reg The register.
 */
void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
void arch_irn_set_register(ir_node *irn, int pos, const arch_register_t *reg);

/**
 * Classify a node.
 * @param irn The node.
 * @return A classification of the node.
 */
arch_irn_class_t arch_irn_classify(const ir_node *irn);

/**
 * Get the flags of a node.
 * @param irn The node.
 * @return The flags.
 */
arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);

void arch_irn_set_flags(ir_node *node, arch_irn_flags_t flags);
void arch_irn_add_flags(ir_node *node, arch_irn_flags_t flags);

#define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)

/**
 * Get the operations of an irn.
 * @param self The handler from which the method is invoked.
 * @param irn Some node.
 * @return Operations for that irn.
 */
typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);

/**
 * Initialize the architecture environment struct.
 * @param isa           The isa which shall be put into the environment.
 * @param file_handle   The file handle
 * @return The environment.
 */
extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
                                 FILE *file_handle, be_main_env_t *main_env);

/**
 * Register an instruction set architecture
 */
void be_register_isa_if(const char *name, const arch_isa_if_t *isa);

/**
 * A register.
 */
struct arch_register_t {
        const char                  *name;       /**< The name of the register. */
        const arch_register_class_t *reg_class;  /**< The class of the register */
        unsigned short               index;      /**< The index of the register in
                                                      the class. */
        unsigned short               global_index;
        arch_register_type_t         type;       /**< The type of the register. */
        /** register constraint allowing just this register */
        const arch_register_req_t   *single_req;
};

static inline const arch_register_class_t *arch_register_get_class(
                const arch_register_t *reg)
{
        return reg->reg_class;
}

static inline unsigned arch_register_get_index(const arch_register_t *reg)
{
        return reg->index;
}

static inline const char *arch_register_get_name(const arch_register_t *reg)
{
        return reg->name;
}

/**
 * Convenience macro to check for register type.
 * @param req   A pointer to register.
 * @param kind  The kind of type to check for (see arch_register_type_t).
 * @return      1, If register is of given kind, 0 if not.
 */
#define arch_register_type_is(reg, kind) \
  (((reg)->type & arch_register_type_ ## kind) != 0)

/**
 * A class of registers.
 * Like general purpose or floating point.
 */
struct arch_register_class_t {
        unsigned                     index;   /**< index of this register class */
        const char                  *name;    /**< The name of the register class.*/
        unsigned                     n_regs;  /**< Number of registers in this
                                                   class. */
        ir_mode                     *mode;    /**< The mode of the register class.*/
        const arch_register_t       *regs;    /**< The array of registers. */
        arch_register_class_flags_t  flags;   /**< register class flags. */
        const arch_register_req_t   *class_req;
};

/** return the number of registers in this register class */
#define arch_register_class_n_regs(cls) ((cls)->n_regs)

/** return the largest mode of this register class */
#define arch_register_class_mode(cls) ((cls)->mode)

/** return the name of this register class */
#define arch_register_class_name(cls) ((cls)->name)

/** return the index of this register class */
#define arch_register_class_index(cls)  ((cls)->index)

/** return the register class flags */
#define arch_register_class_flags(cls) ((cls)->flags)

static inline const arch_register_t *arch_register_for_index(
                const arch_register_class_t *cls, unsigned idx)
{
        assert(idx < cls->n_regs);
        return &cls->regs[idx];
}

/**
 * Convenience macro to check for set constraints.
 * @param req   A pointer to register requirements.
 * @param kind  The kind of constraint to check for
 *              (see arch_register_req_type_t).
 * @return      1, If the kind of constraint is present, 0 if not.
 */
#define arch_register_req_is(req, kind) \
        (((req)->type & (arch_register_req_type_ ## kind)) != 0)

/**
 * Expresses requirements to register allocation for an operand.
 */
struct arch_register_req_t {
        arch_register_req_type_t     type; /**< The type of the constraint. */
        const arch_register_class_t *cls;  /**< The register class this constraint
                                                belongs to. */
        const unsigned *limited;            /**< allowed register bitset */
        unsigned other_same;                /**< Bitmask of ins which should use the
                                                 same register (should_be_same). */
        unsigned other_different;           /**< Bitmask of ins which shall use a
                                                 different register
                                                 (must_be_different) */
        unsigned char width;                /**< specifies how many sequential
                                                 registers are required */
};

static inline int reg_reqs_equal(const arch_register_req_t *req1,
                                 const arch_register_req_t *req2)
{
        if (req1 == req2)
                return 1;

        if (req1->type != req2->type
                        || req1->cls != req2->cls
                        || req1->other_same != req2->other_same
                        || req1->other_different != req2->other_different)
                return 0;

        if (req1->limited != NULL) {
                size_t n_regs;

                if (req2->limited == NULL)
                        return 0;

                n_regs = arch_register_class_n_regs(req1->cls);
                if (!rbitsets_equal(req1->limited, req2->limited, n_regs))
                        return 0;
        }

        return 1;
}

/**
 * An inverse operation returned by the backend
 */
struct arch_inverse_t {
        int      n;       /**< count of nodes returned in nodes array */
        int      costs;   /**< costs of this remat */

        /** nodes for this inverse operation. shall be in schedule order.
         * last element is the target value */
        ir_node  **nodes;
};

struct arch_irn_ops_t {

        /**
         * Classify the node.
         * @param irn The node.
         * @return A classification.
         */
        arch_irn_class_t (*classify)(const ir_node *irn);

        /**
         * Get the entity on the stack frame this node depends on.
         * @param irn  The node in question.
         * @return The entity on the stack frame or NULL, if the node does not have
         *         a stack frame entity.
         */
        ir_entity *(*get_frame_entity)(const ir_node *irn);

        /**
         * Set the offset of a node carrying an entity on the stack frame.
         * @param irn  The node.
         * @param offset The offset of the node's stack frame entity.
         */
        void (*set_frame_offset)(ir_node *irn, int offset);

        /**
         * Returns the delta of the stackpointer for nodes that increment or
         * decrement the stackpointer with a constant value. (push, pop
         * nodes on most architectures).
         * A positive value stands for an expanding stack area, a negative value for
         * a shrinking one.
         *
         * @param irn       The node
         * @return          0 if the stackpointer is not modified with a constant
         *                  value, otherwise the increment/decrement value
         */
        int (*get_sp_bias)(const ir_node *irn);

        /**
         * Returns an inverse operation which yields the i-th argument
         * of the given node as result.
         *
         * @param irn       The original operation
         * @param i         Index of the argument we want the inverse operation to
         *                  yield
         * @param inverse   struct to be filled with the resulting inverse op
         * @param obstack   The obstack to use for allocation of the returned nodes
         *                  array
         * @return          The inverse operation or NULL if operation invertible
         */
        arch_inverse_t *(*get_inverse)(const ir_node *irn, int i,
                                       arch_inverse_t *inverse,
                                       struct obstack *obstack);

        /**
         * Get the estimated cycle count for @p irn.
         *
         * @param irn  The node.
         * @return     The estimated cycle count for this operation
         */
        int (*get_op_estimated_cost)(const ir_node *irn);

        /**
         * Asks the backend whether operand @p i of @p irn can be loaded form memory
         * internally
         *
         * @param irn  The node.
         * @param i    Index of the argument we would like to know whether @p irn
         *             can load it form memory internally
         * @return     nonzero if argument can be loaded or zero otherwise
         */
        int (*possible_memory_operand)(const ir_node *irn, unsigned int i);

        /**
         * Ask the backend to assimilate @p reload of operand @p i into @p irn.
         *
         * @param irn    The node.
         * @param spill  The spill.
         * @param i      The position of the reload.
         */
        void (*perform_memory_operand)(ir_node *irn, ir_node *spill,
                                       unsigned int i);
};

/**
 * Architecture interface.
 */
struct arch_isa_if_t {
        /**
         * Initialize the isa interface.
         * @param file_handle  the file handle to write the output to
         * @return a new isa instance
         */
        arch_env_t *(*init)(FILE *file_handle);

        /**
         * Free the isa instance.
         */
        void (*done)(void *self);

        /**
         * Called directly after initialization. Backend should handle all
         * intrinsics here.
         */
        void (*handle_intrinsics)(void);

        /**
         * Get the register class which shall be used to store a value of a given
         * mode.
         * @param self The this pointer.
         * @param mode The mode in question.
         * @return A register class which can hold values of the given mode.
         */
        const arch_register_class_t *(*get_reg_class_for_mode)(const ir_mode *mode);

        /**
         * Get the ABI restrictions for procedure calls.
         * @param self        The this pointer.
         * @param call_type   The call type of the method (procedure) in question.
         * @param p           The array of parameter locations to be filled.
         */
        void (*get_call_abi)(const void *self, ir_type *call_type,
                             be_abi_call_t *abi);

        /**
         * Get the necessary alignment for storing a register of given class.
         * @param self  The isa object.
         * @param cls   The register class.
         * @return      The alignment in bytes.
         */
        int (*get_reg_class_alignment)(const arch_register_class_t *cls);

        /**
         * A "static" function, returns the frontend settings
         * needed for this backend.
         */
        const backend_params *(*get_params)(void);

        /**
         * Return an ordered list of irgs where code should be generated for.
         * If NULL is returned, all irg will be taken into account and they will be
         * generated in an arbitrary order.
         * @param self   The isa object.
         * @param irgs   A flexible array ARR_F of length 0 where the backend can
         *               append the desired irgs.
         * @return A flexible array ARR_F containing all desired irgs in the
         *         desired order.
         */
        ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);

        /**
         * mark node as rematerialized
         */
        void (*mark_remat)(ir_node *node);

        /**
         * parse an assembler constraint part and set flags according to its nature
         * advances the *c pointer to point to the last parsed character (so if you
         * parse a single character don't advance c)
         */
        asm_constraint_flags_t (*parse_asm_constraint)(const char **c);

        /**
         * returns true if the string is a valid clobbered (register) in this
         * backend
         */
        int (*is_valid_clobber)(const char *clobber);

        /**
         * Initialize the code generator.
         * @param irg  A graph
         * @return     A newly created code generator.
         */
        void (*init_graph)(ir_graph *irg);

        /**
         * return node used as base in pic code addresses
         */
        ir_node* (*get_pic_base)(ir_graph *irg);

        /**
         * Called before abi introduce.
         */
        void (*before_abi)(ir_graph *irg);

        /**
         * Called, when the graph is being normalized.
         */
        void (*prepare_graph)(ir_graph *irg);

        /**
         * Called before register allocation.
         */
        void (*before_ra)(ir_graph *irg);

        /**
         * Called after register allocation.
         */
        void (*after_ra)(ir_graph *irg);

        /**
         * Called directly before done is called. This should be the last place
         * where the irg is modified.
         */
        void (*finish)(ir_graph *irg);

        /**
         * Called after everything happened. This call should emit the final
         * assembly code but avoid changing the irg.
         * The code generator must also be de-allocated here.
         */
        void (*emit)(ir_graph *irg);
};

#define arch_env_done(env)                             ((env)->impl->done(env))
#define arch_env_handle_intrinsics(env)                \
        do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
#define arch_env_get_reg_class_for_mode(env,mode)      ((env)->impl->get_reg_class_for_mode((mode)))
#define arch_env_get_call_abi(env,tp,abi)              ((env)->impl->get_call_abi((env), (tp), (abi)))
#define arch_env_get_reg_class_alignment(env,cls)      ((env)->impl->get_reg_class_alignment((cls)))
#define arch_env_get_params(env)                       ((env)->impl->get_params())
#define arch_env_get_allowed_execution_units(env,irn)  ((env)->impl->get_allowed_execution_units((irn)))
#define arch_env_get_machine(env)                      ((env)->impl->get_machine(env))
#define arch_env_get_backend_irg_list(env,irgs)        ((env)->impl->get_backend_irg_list((env), (irgs)))
#define arch_env_parse_asm_constraint(env,c)           ((env)->impl->parse_asm_constraint((c))
#define arch_env_is_valid_clobber(env,clobber)         ((env)->impl->is_valid_clobber((clobber))
#define arch_env_mark_remat(env,node) \
        do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((node)); } while(0)

/**
 * ISA base class.
 */
struct arch_env_t {
        const arch_isa_if_t   *impl;
        unsigned               n_registers;      /**< number of registers */
        const arch_register_t *registers;        /**< register array */
        unsigned               n_register_classes; /**< number of register classes*/
        const arch_register_class_t *register_classes; /**< register classes */
        const arch_register_t *sp;               /**< The stack pointer register. */
        const arch_register_t *bp;               /**< The base pointer register. */
        const arch_register_class_t *link_class; /**< The static link pointer
                                                      register class. */
        int                    stack_dir;        /**< -1 for decreasing, 1 for
                                                      increasing. */
        int                    stack_alignment;  /**< power of 2 stack alignment */
        const be_main_env_t   *main_env;         /**< the be main environment */
        int                    spill_cost;       /**< cost for a be_Spill node */
        int                    reload_cost;      /**< cost for a be_Reload node */
        bool                   custom_abi : 1;   /**< backend does all abi handling
                                                      and does not need the generic
                                                      stuff from beabi.h/.c */
};

static inline unsigned arch_irn_get_n_outs(const ir_node *node)
{
        backend_info_t *info = be_get_info(node);
        if (info->out_infos == NULL)
                return 0;

        return ARR_LEN(info->out_infos);
}

static inline const arch_irn_ops_t *get_irn_ops_simple(const ir_node *node)
{
        const ir_op          *ops    = get_irn_op(node);
        const arch_irn_ops_t *be_ops = get_op_ops(ops)->be_ops;
        assert(!is_Proj(node));
        return be_ops;
}

static inline const arch_register_req_t *arch_get_register_req_out(
                const ir_node *irn)
{
        int             pos = 0;
        backend_info_t *info;

        /* you have to query the Proj nodes for the constraints (or use
         * arch_get_out_register_req. Querying a mode_T node and expecting
         * arch_no_register_req is a bug in your code! */
        assert(get_irn_mode(irn) != mode_T);

        if (is_Proj(irn)) {
                pos = get_Proj_proj(irn);
                irn = get_Proj_pred(irn);
        }

        info = be_get_info(irn);
        if (info->out_infos == NULL)
                return arch_no_register_req;

        return info->out_infos[pos].req;
}

static inline bool arch_irn_is_ignore(const ir_node *irn)
{
        const arch_register_req_t *req = arch_get_register_req_out(irn);
        return !!(req->type & arch_register_req_type_ignore);
}

static inline bool arch_irn_consider_in_reg_alloc(
                const arch_register_class_t *cls, const ir_node *node)
{
        const arch_register_req_t *req = arch_get_register_req_out(node);
        return
                req->cls == cls &&
                !(req->type & arch_register_req_type_ignore);
}

/**
 * Get register constraints for an operand at position @p
 */
static inline const arch_register_req_t *arch_get_in_register_req(
                const ir_node *node, int pos)
{
        const backend_info_t *info = be_get_info(node);
        if (info->in_reqs == NULL)
                return arch_no_register_req;
        return info->in_reqs[pos];
}

/**
 * Get register constraint for a produced result (the @p pos result)
 */
static inline const arch_register_req_t *arch_get_out_register_req(
                const ir_node *node, int pos)
{
        const backend_info_t *info = be_get_info(node);
        if (info->out_infos == NULL)
                return arch_no_register_req;
        return info->out_infos[pos].req;
}

static inline void arch_set_out_register_req(ir_node *node, int pos,
                const arch_register_req_t *req)
{
        backend_info_t *info = be_get_info(node);
        assert(pos < (int) arch_irn_get_n_outs(node));
        info->out_infos[pos].req = req;
}

static inline void arch_set_in_register_reqs(ir_node *node,
                                            const arch_register_req_t **in_reqs)
{
        backend_info_t *info = be_get_info(node);
        info->in_reqs = in_reqs;
}

static inline const arch_register_req_t **arch_get_in_register_reqs(
                const ir_node *node)
{
        backend_info_t *info = be_get_info(node);
        return info->in_reqs;
}

/**
 * Iterate over all values defined by an instruction.
 * Only looks at values in a certain register class where the requirements
 * are not marked as ignore.
 * Executes @p code for each definition.
 */
#define be_foreach_definition_(node, cls, value, code)                     \
        do {                                                                   \
        if (get_irn_mode(node) == mode_T) {                                    \
                const ir_edge_t *edge_;                                            \
                foreach_out_edge(node, edge_) {                                    \
                        const arch_register_req_t *req_;                               \
                        value = get_edge_src_irn(edge_);                               \
                        req_  = arch_get_register_req_out(value);                      \
                        if (req_->cls != cls)                                          \
                                continue;                                                  \
                        code                                                           \
                }                                                                  \
        } else {                                                               \
                const arch_register_req_t *req_ = arch_get_register_req_out(node); \
                value = node;                                                      \
                if (req_->cls == cls) {                                            \
                        code                                                           \
                }                                                                  \
        }                                                                      \
        } while (0)

#define be_foreach_definition(node, cls, value, code)                      \
        be_foreach_definition_(node, cls, value,                               \
                if (req_->type & arch_register_req_type_ignore)                    \
                        continue;                                                      \
                code                                                               \
        )

#endif