nsz Git - libfirm/blob - ir/be/bearch.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Processor architecture specification.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BEARCH_H
  27 #define FIRM_BE_BEARCH_H
  28
  29 #include "firm_types.h"
  30 #include "bitset.h"
  31 #include "be.h"
  32
  33 typedef struct arch_register_class_t     arch_register_class_t;
  34 typedef struct arch_register_req_t       arch_register_req_t;
  35 typedef struct arch_register_t           arch_register_t;
  36 typedef struct arch_flag_t               arch_flag_t;
  37 typedef struct arch_inverse_t            arch_inverse_t;
  38 typedef struct arch_isa_if_t             arch_isa_if_t;
  39 typedef struct arch_isa_t                arch_isa_t;
  40 typedef struct arch_env_t                arch_env_t;
  41 typedef struct arch_irn_ops_if_t         arch_irn_ops_if_t;
  42 typedef struct arch_irn_ops_t            arch_irn_ops_t;
  43 typedef struct arch_irn_handler_t        arch_irn_handler_t;
  44 typedef struct arch_code_generator_t     arch_code_generator_t;
  45 typedef struct arch_code_generator_if_t  arch_code_generator_if_t;
  46
  47 typedef enum arch_register_type_t {
  48         arch_register_type_none         = 0,
  49         arch_register_type_caller_save  = 1,  /**< The register must be saved by the caller
  50                                              upon a function call. It thus can be overwritten
  51                                              in the called function. */
  52         arch_register_type_callee_save  = 2,  /**< The register must be saved by the caller
  53                                              upon a function call. It thus can be overwritten
  54                                              in the called function. */
  55         arch_register_type_ignore       = 4,  /**< Do not consider this register when allocating. */
  56         arch_register_type_joker        = 8,  /**< The emitter can choose an arbitrary register */
  57         arch_register_type_virtual      = 16, /**< This is just a virtual register  */
  58         arch_register_type_state        = 32,
  59 } arch_register_type_t;
  60
  61 /**
  62  * Put all registers in a class into a bitset.
  63  * @param cls The class.
  64  * @param bs The bitset. May be NULL.
  65  * @return The number of registers in the class.
  66  */
  67 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
  68
  69 typedef enum arch_operand_type_t {
  70         arch_operand_type_invalid,
  71         arch_operand_type_memory,
  72         arch_operand_type_register,
  73         arch_operand_type_immediate,
  74         arch_operand_type_symconst,
  75         arch_operand_type_last
  76 } arch_operand_type_t;
  77
  78 /**
  79  * Different types of register allocation requirements.
  80  */
  81 typedef enum arch_register_req_type_t {
  82         arch_register_req_type_none                         = 0,  /**< No register requirement. */
  83         arch_register_req_type_normal                       = 1,  /**< All registers in the class are allowed. */
  84         arch_register_req_type_limited                      = 2,  /**< Only a real subset of the class is allowed. */
  85         arch_register_req_type_should_be_same               = 4,  /**< The register should be equal another one at the node. */
  86         arch_register_req_type_should_be_different          = 8,  /**< The register must be unequal to some other at the node. */
  87         arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from all in's at the node */
  88 } arch_register_req_type_t;
  89
  90 extern const arch_register_req_t *arch_no_register_req;
  91
  92 /**
  93  * Format a register requirements information into a string.
  94  * @param buf The string where to put it to.
  95  * @param len The size of @p buf.
  96  * @param req The requirements structure to format.
  97  * @return    A pointer to buf.
  98  */
  99 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req, const ir_node *node);
 100
 101 /**
 102  * Certain node classes which are relevant for the register allocator.
 103  */
 104 typedef enum arch_irn_class_t {
 105         arch_irn_class_normal     = 1 << 0,
 106         arch_irn_class_spill      = 1 << 1,
 107         arch_irn_class_reload     = 1 << 2,
 108         arch_irn_class_copy       = 1 << 3,
 109         arch_irn_class_perm       = 1 << 4,
 110         arch_irn_class_branch     = 1 << 5,
 111         arch_irn_class_call       = 1 << 6,
 112         arch_irn_class_const      = 1 << 7,
 113         arch_irn_class_load       = 1 << 8,
 114         arch_irn_class_store      = 1 << 9,
 115         arch_irn_class_stackparam = 1 << 10,
 116 } arch_irn_class_t;
 117
 118 /**
 119  * Some flags describing a node in more detail.
 120  */
 121 typedef enum arch_irn_flags_t {
 122         arch_irn_flags_none             = 0, /**< Node flags. */
 123         arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
 124         arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
 125         arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
 126         arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
 127         arch_irn_flags_last             = arch_irn_flags_modify_sp
 128 } arch_irn_flags_t;
 129
 130 /**
 131  * Get the string representation of a flag.
 132  * This functions does not handle or'ed bitmasks of flags.
 133  * @param flag The flag.
 134  * @return The flag as a string.
 135  */
 136 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
 137
 138 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env,
 139                                               const ir_node *irn);
 140
 141 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
 142
 143 extern ir_entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
 144 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, ir_entity *ent);
 145 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
 146
 147 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
 148 extern arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
 149 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
 150 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
 151
 152 /**
 153  * Get the register requirements for a node.
 154  * @param env The architecture environment.
 155  * @param req A pointer to a requirements structure, where the data can
 156  *            be put into.
 157  * @param irn The node.
 158  * @param pos The position of the operand you're interested in.
 159  * @return    A pointer to the register requirements which may <b>not</b>
 160  *            neccessarily be equal to @p req. If NULL is returned, the
 161  *            operand was no register operand.
 162  */
 163 extern const arch_register_req_t *
 164 arch_get_register_req(const arch_env_t *env, const ir_node *irn, int pos);
 165
 166 /**
 167  * Check if an operand is a register operand.
 168  * @param env The environment.
 169  * @param irn The node.
 170  * @param pos The position of the operand.
 171  * @return 1, if the operand is significant for register allocation, 0
 172  * if not.
 173  */
 174 extern int arch_is_register_operand(const arch_env_t *env,
 175     const ir_node *irn, int pos);
 176
 177 /**
 178  * Get the number of allocatable registers concerning
 179  * a register class for an operand of a node.
 180  * @param env The environment.
 181  * @param irn The node.
 182  * @param pos The postition of the node's operand.
 183  * @param bs  The bitset all allocatable registers shall be put into.
 184  *            Note, that you can also pass NULL here. If you don't,
 185  *            make sure, the bitset is as large as the register class
 186  *            has registers.
 187  * @return    The amount of registers allocatable for that operand.
 188  */
 189 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
 190
 191 /**
 192  * Put all registers which shall not be ignored by the register
 193  * allocator in a bit set.
 194  * @param env The arch env.
 195  * @param cls The register class to consider.
 196  * @param bs  The bit set to put the registers to.
 197  */
 198 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
 199
 200 /**
 201  * Check, if a register is assignable to an operand of a node.
 202  * @param env The architecture environment.
 203  * @param irn The node.
 204  * @param pos The position of the operand.
 205  * @param reg The register.
 206  * @return    1, if the register might be allocated to the operand 0 if not.
 207  */
 208 extern int arch_reg_is_allocatable(const arch_env_t *env,
 209     const ir_node *irn, int pos, const arch_register_t *reg);
 210
 211 /**
 212  * Get the register class of an operand of a node.
 213  * @param env The architecture environment.
 214  * @param irn The node.
 215  * @param pos The position of the operand, -1 for the output.
 216  * @return    The register class of the operand or NULL, if
 217  *            operand is a non-register operand.
 218  */
 219 extern const arch_register_class_t *
 220 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 221
 222 /**
 223  * Get the register allocated at a certain output operand of a node.
 224  * @param env The arch environment.
 225  * @param irn The node.
 226  * @return    The register allocated for this operand
 227  */
 228 extern const arch_register_t *
 229 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 230
 231 /**
 232  * Set the register for a certain output operand.
 233  * @param env The architecture environment.
 234  * @param irn The node.
 235  * @param idx The index of the output operand.
 236  * @param reg The register.
 237  */
 238 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 239                 const arch_register_t *reg);
 240
 241 /**
 242  * Classify a node.
 243  * @param env The architecture environment.
 244  * @param irn The node.
 245  * @return A classification of the node.
 246  */
 247 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 248
 249 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
 250
 251 /**
 252  * Get the flags of a node.
 253  * @param env The architecture environment.
 254  * @param irn The node.
 255  * @return The flags.
 256  */
 257 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 258
 259 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
 260
 261 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 262         ((cls) == arch_get_irn_reg_class(env, irn, pos))
 263
 264 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
 265         (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
 266
 267 /**
 268  * Initialize the architecture environment struct.
 269  * @param isa           The isa which shall be put into the environment.
 270  * @param file_handle   The file handle
 271  * @return The environment.
 272  */
 273 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa,
 274                                  FILE *file_handle, be_main_env_t *main_env);
 275
 276 /**
 277  * Add a node handler to the environment.
 278  * @param env The environment.
 279  * @param handler A node handler.
 280  * @return The environment itself.
 281  */
 282 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
 283
 284 /**
 285  * Remove a node handler from the handler stack.
 286  * @param env The architecture environment.
 287  * @return The popped handler.
 288  */
 289 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 290
 291 /**
 292  * Register an instruction set architecture
 293  */
 294 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
 295
 296 #endif /* FIRM_BE_BEARCH_H */