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

   1 #ifndef _FIRM_BEARCH_H
   2 #define _FIRM_BEARCH_H
   3
   4 #ifdef HAVE_CONFIG_H
   5 #include "config.h"
   6 #endif
   7
   8
   9 #ifdef WITH_LIBCORE
  10 #include <libcore/lc_opts.h>
  11 #endif
  12
  13 #include "irnode.h"
  14 #include "irmode.h"
  15
  16 #include "bitset.h"
  17 #include "hashptr.h"
  18 #include "fourcc.h"
  19 #include "set.h"
  20 #include "list.h"
  21 #include "ident.h"
  22
  23 #include "belistsched.h"
  24
  25 typedef struct _arch_register_class_t     arch_register_class_t;
  26 typedef struct _arch_register_t           arch_register_t;
  27 typedef struct _arch_isa_if_t             arch_isa_if_t;
  28 typedef struct _arch_isa_t                arch_isa_t;
  29 typedef struct _arch_env_t                arch_env_t;
  30 typedef struct _arch_irn_ops_if_t         arch_irn_ops_if_t;
  31 typedef struct _arch_irn_ops_t            arch_irn_ops_t;
  32 typedef struct _arch_irn_handler_t        arch_irn_handler_t;
  33 typedef struct _arch_code_generator_t     arch_code_generator_t;
  34 typedef struct _arch_code_generator_if_t  arch_code_generator_if_t;
  35
  36 struct _be_node_factory_t;
  37
  38 typedef enum _arch_register_type_t {
  39   arch_register_type_none = 0,
  40   arch_register_type_caller_saved,    /**< The register must be saved by the caller
  41                                            upon a function call. It thus can be overwritten
  42                                            in the called function. */
  43   arch_register_type_callee_saved,    /**< The register must be saved by the called function,
  44                                            it thus survives a function call. */
  45   arch_register_type_ignore           /**< Do not consider this register when allocating. */
  46 } arch_register_type_t;
  47
  48 /**
  49  * Convenience macro to check for register type.
  50  * @param req   A pointer to register.
  51  * @param kind  The kind of type to check for (see arch_register_type_t).
  52  * @return      1, If register is of given kind, 0 if not.
  53  */
  54 #define arch_register_type_is(reg, kind) \
  55         ((reg)->type == arch_register_type_ ## kind)
  56
  57 /**
  58  * A register.
  59  */
  60 struct _arch_register_t {
  61   const char *name;                         /**< The name of the register. */
  62   const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  63   int index;                                /**< The index of the register in the class. */
  64   arch_register_type_t type;                /**< The type of the register. */
  65   void *data;                               /**< Custom data. */
  66 };
  67
  68 static INLINE const arch_register_class_t *
  69 _arch_register_get_class(const arch_register_t *reg)
  70 {
  71   return reg->reg_class;
  72 }
  73
  74 static INLINE int _arch_register_get_index(const arch_register_t *reg)
  75 {
  76   return reg->index;
  77 }
  78
  79 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  80 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  81 #define arch_register_get_name(reg)       ((reg)->name)
  82
  83 /**
  84  * A class of registers.
  85  * Like general purpose or floating point.
  86  */
  87 struct _arch_register_class_t {
  88   const char *name;               /**< The name of the register class. */
  89   int n_regs;                     /**< Number of registers in this class. */
  90   const arch_register_t *regs;    /**< The array of registers. */
  91 };
  92
  93 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  94
  95 /**
  96  * Put all registers in a class into a bitset.
  97  * @param cls The class.
  98  * @param bs The bitset. May be NULL.
  99  * @return The number of registers in the class.
 100  */
 101 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
 102
 103 static INLINE const arch_register_t *
 104 _arch_register_for_index(const arch_register_class_t *cls, int idx)
 105 {
 106   assert(0 <= idx && idx < cls->n_regs);
 107   return &cls->regs[idx];
 108 }
 109
 110 #define arch_register_for_index(cls, idx) \
 111   _arch_register_for_index(cls, idx)
 112
 113 typedef enum _arch_operand_type_t {
 114   arch_operand_type_invalid,
 115   arch_operand_type_memory,
 116   arch_operand_type_register,
 117   arch_operand_type_immediate,
 118   arch_operand_type_symconst,
 119   arch_operand_type_last
 120 } arch_operand_type_t;
 121
 122 /**
 123  * Different types of register allocation requirements.
 124  */
 125 typedef enum _arch_register_req_type_t {
 126   arch_register_req_type_none = 0,        /**< No register requirement. */
 127
 128   arch_register_req_type_normal = 1,      /**< All registers in the class
 129                                                are allowed. */
 130
 131   arch_register_req_type_limited = 2,     /**< Only a real subset of
 132                                                the class is allowed. */
 133
 134   arch_register_req_type_should_be_same = 4,       /**< The register should be equal
 135                                                         another one at the node. */
 136
 137   arch_register_req_type_should_be_different = 8,  /**< The register must be unequal
 138                                                         to some other at the node. */
 139
 140 } arch_register_req_type_t;
 141
 142 /**
 143  * Convenience macro to check for set constraints.
 144  * @param req   A pointer to register requirements.
 145  * @param kind  The kind of constraint to check for (see arch_register_req_type_t).
 146  * @return      1, If the kind of constraint is present, 0 if not.
 147  */
 148 #define arch_register_req_is(req, kind) \
 149         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 150
 151 /**
 152  * Expresses requirements to register allocation for an operand.
 153  */
 154 typedef struct _arch_register_req_t {
 155         arch_register_req_type_t type;          /**< The type of the constraint. */
 156         const arch_register_class_t *cls;       /**< The register class this constraint belongs to. */
 157
 158         void (*limited)(const ir_node *irn, int pos, bitset_t *bs);
 159                                           /**< In case of the 'limited'
 160                                             constraint, this function
 161                                             must put all allowable
 162                                             registers in the bitset and
 163                                             return the number of registers
 164                                             in the bitset. */
 165
 166         ir_node *other;                                           /**< In case of "should be equal"
 167                                                                                     or should be different, this gives
 168                                                                                         the node to whose register this
 169                                                                                         one's should be the same/different. */
 170 } arch_register_req_t;
 171
 172 /**
 173  * Certain node classes which are relevant for the register allocator.
 174  */
 175 typedef enum _arch_irn_class_t {
 176   arch_irn_class_normal,
 177   arch_irn_class_spill,
 178   arch_irn_class_reload,
 179   arch_irn_class_copy,
 180   arch_irn_class_perm,
 181   arch_irn_class_branch,
 182   arch_irn_class_call
 183 } arch_irn_class_t;
 184
 185 /**
 186  * Some flags describing a node in more detail.
 187  */
 188 typedef enum _arch_irn_flags_t {
 189   arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
 190   arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
 191   arch_irn_flags_ignore           = 4, /**< Do not consider the node during register allocation. */
 192 } arch_irn_flags_t;
 193
 194 struct _arch_irn_ops_if_t {
 195
 196   /**
 197    * Get the register requirements for a given operand.
 198    * @param self The self pointer.
 199    * @param irn The node.
 200    * @param pos The operand's position
 201          *                                              (-1 for the result of the node, 0..n for the input
 202          *                                              operands).
 203    * @return    The register requirements for the selected operand.
 204    *            The pointer returned is never NULL.
 205    */
 206   const arch_register_req_t *(*get_irn_reg_req)(const void *self,
 207       arch_register_req_t *req, const ir_node *irn, int pos);
 208
 209   /**
 210    * Set the register for an output operand.
 211    * @param irn The node.
 212    * @param reg The register allocated to that operand.
 213    * @note      If the operand is not a register operand,
 214    *            the call is ignored.
 215    */
 216   void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 217
 218   /**
 219    * Get the register allocated for an output operand.
 220    * @param irn The node.
 221    * @return    The register allocated at that operand. NULL, if
 222    *            the operand was no register operand or
 223    *            @c arch_register_invalid, if no register has yet been
 224    *            allocated for this node.
 225    */
 226   const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 227
 228   /**
 229    * Classify the node.
 230    * @param irn The node.
 231    * @return A classification.
 232    */
 233   arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 234
 235   /**
 236    * Get the flags of a node.
 237    * @param self The irn ops themselves.
 238    * @param irn The node.
 239    * @return A set of flags.
 240    */
 241   arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 242
 243 };
 244
 245 /**
 246  * irn_ops base class.
 247  */
 248 struct _arch_irn_ops_t {
 249         const arch_irn_ops_if_t *impl;
 250 };
 251
 252 /**
 253  * Get the register requirements for a node.
 254  * @param env The architecture environment.
 255  * @param req A pointer to a requirements structure, where the data can
 256  *            be put into.
 257  * @param irn The node.
 258  * @param pos The position of the operand you're interested in.
 259  * @return    A pointer to the register requirements which may <b>not</b>
 260  *            neccessarily be equal to @p req. If NULL is returned, the
 261  *            operand was no register operand.
 262  */
 263 extern const arch_register_req_t *
 264 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 265     const ir_node *irn, int pos);
 266
 267 /**
 268  * Check if an operand is a register operand.
 269  * @param env The environment.
 270  * @param irn The node.
 271  * @param pos The position of the operand.
 272  * @return 1, if the operand is significant for register allocation, 0
 273  * if not.
 274  */
 275 extern int arch_is_register_operand(const arch_env_t *env,
 276     const ir_node *irn, int pos);
 277
 278 /**
 279  * Get the number of allocatable registers concerning
 280  * a register class for an operand of a node.
 281  * @param env The environment.
 282  * @param irn The node.
 283  * @param pos The postition of the node's operand.
 284  * @param cls The register class.
 285  * @param bs  The bitset all allocatable registers shall be put into.
 286  *            Note, that you can also pass NULL here. If you don't,
 287  *            make sure, the bitset is as large as the register class
 288  *            has registers.
 289  * @return    The amount of registers allocatable for that operand.
 290  */
 291 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
 292     int pos, const arch_register_class_t *cls, bitset_t *bs);
 293
 294 /**
 295  * Check, if a register is assignable to an operand of a node.
 296  * @param env The architecture environment.
 297  * @param irn The node.
 298  * @param pos The position of the operand.
 299  * @param reg The register.
 300  * @return    1, if the register might be allocated to the operand 0 if not.
 301  */
 302 extern int arch_reg_is_allocatable(const arch_env_t *env,
 303     const ir_node *irn, int pos, const arch_register_t *reg);
 304
 305 /**
 306  * Get the register class of an operand of a node.
 307  * @param env The architecture environment.
 308  * @param irn The node.
 309  * @param pos The position of the operand.
 310  * @return    The register class of the operand or NULL, if
 311  *            operand is a non-register operand.
 312  */
 313 extern const arch_register_class_t *
 314 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 315
 316 /**
 317  * Get the register allocated at a certain output operand of a node.
 318  * @param env The arch environment.
 319  * @param irn The node.
 320  * @return    The register allocated for this operand
 321  */
 322 extern const arch_register_t *
 323 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 324
 325 /**
 326  * Set the register for a certain output operand.
 327  * @param env The architecture environment.
 328  * @param irn The node.
 329  * @param idx The index of the output operand.
 330  * @param reg The register.
 331  */
 332 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 333                 const arch_register_t *reg);
 334
 335 /**
 336  * Classify a node.
 337  * @param env The architecture environment.
 338  * @param irn The node.
 339  * @return A classification of the node.
 340  */
 341 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 342
 343 /**
 344  * Get the flags of a node.
 345  * @param env The architecture environment.
 346  * @param irn The node.
 347  * @return The flags.
 348  */
 349 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 350
 351 #define arch_irn_is_ignore(env, irn) \
 352         (arch_irn_get_flags(env, irn) == arch_irn_flags_ignore)
 353
 354 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 355   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 356
 357 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
 358         (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is_ignore(env, irn))
 359
 360 /**
 361  * Somebody who can be asked about nodes.
 362  */
 363 struct _arch_irn_handler_t {
 364
 365   /**
 366     * Get the operations of an irn.
 367     * @param self The handler from which the method is invoked.
 368     * @param irn Some node.
 369     * @return Operations for that irn.
 370     */
 371   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
 372       const ir_node *irn);
 373
 374 };
 375
 376 /**
 377  * The code generator.
 378  */
 379 struct _arch_code_generator_if_t {
 380
 381
 382         /**
 383          * Initialize the code generator.
 384          * @param file The file to dump to.
 385          * @param irg  The function to generate code for.
 386          * @param env  The architecture environment.
 387          * @return     A newly created code generator.
 388          */
 389         void *(*init)(FILE *file, ir_graph *irg, const arch_env_t *env);
 390
 391         /**
 392          * Called, when the graph is being normalized.
 393          */
 394         void (*prepare_graph)(void *self);
 395
 396         /**
 397          * Called before scheduling.
 398          */
 399         void (*before_sched)(void *self);
 400
 401         /**
 402          * Called before register allocation.
 403          */
 404         void (*before_ra)(void *self);
 405
 406         /**
 407          * Called after register allocation to lower Spills to Stores
 408          */
 409         ir_node *(*lower_spill)(void *self, ir_node *spill);
 410
 411         /**
 412          * Called after register allocation to lower Reloads to Loads
 413          */
 414         ir_node *(*lower_reload)(void *self, ir_node *reload);
 415
 416         /**
 417          * Called after everything happened.
 418          * The code generator must also be de-allocated here.
 419          */
 420         void (*done)(void *self);
 421
 422 };
 423
 424 #define _arch_cg_call(cg, func) \
 425 do { \
 426         if((cg)->impl->func) \
 427                 (cg)->impl->func(cg); \
 428 } while(0)
 429
 430 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 431 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 432 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 433 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 434
 435 /**
 436  * Code generator base class.
 437  */
 438 struct _arch_code_generator_t {
 439         const arch_code_generator_if_t *impl;
 440 };
 441
 442 /**
 443  * ISA base class.
 444  */
 445 struct _arch_isa_t {
 446         const arch_isa_if_t *impl;
 447 };
 448
 449 /**
 450  * Architecture interface.
 451  */
 452 struct _arch_isa_if_t {
 453
 454 #ifdef WITH_LIBCORE
 455   void (*register_options)(lc_opt_entry_t *grp);
 456 #endif
 457
 458   /**
 459    * Initialize the isa interface.
 460    */
 461   void *(*init)(void);
 462
 463   /**
 464    * Free the isa instance.
 465    */
 466   void (*done)(void *self);
 467
 468   /**
 469    * Get the the number of register classes in the isa.
 470    * @return The number of register classes.
 471    */
 472   int (*get_n_reg_class)(const void *self);
 473
 474   /**
 475    * Get the i-th register class.
 476    * @param i The number of the register class.
 477    * @return The register class.
 478    */
 479   const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 480
 481   /**
 482    * The irn handler for this architecture.
 483    * The irn handler is registered by the Firm back end
 484    * when the architecture is initialized.
 485    * (May be NULL).
 486    */
 487   const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 488
 489   /**
 490    * Get the code generator interface.
 491    * @param self The this pointer.
 492    * @return     Some code generator interface.
 493    */
 494   const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 495
 496   /**
 497    * Get the list scheduler to use.
 498    * @param self  The isa object.
 499    * @return      The list scheduler selector.
 500    */
 501   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
 502
 503   /**
 504    * Get the proj number assigned to the register.
 505    * @param self  The isa object.
 506    * @param reg   The register
 507    * @return      The proj number assigned to this register
 508    */
 509   long (*get_projnum_for_register)(const void *self, const arch_register_t *reg);
 510 };
 511
 512 #define arch_isa_get_n_reg_class(isa)           ((isa)->impl->get_n_reg_class(isa))
 513 #define arch_isa_get_reg_class(isa,i)           ((isa)->impl->get_reg_class(isa, i))
 514 #define arch_isa_get_irn_handler(isa)           ((isa)->impl->get_irn_handler(isa))
 515 #define arch_isa_make_code_generator(isa,irg)   ((isa)->impl->make_code_generator(isa, irg))
 516
 517 #define ARCH_MAX_HANDLERS         8
 518
 519 /**
 520  * Environment for the architecture infrastructure.
 521  * Keep this everywhere you're going.
 522  */
 523 struct _arch_env_t {
 524   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 525   arch_isa_t *isa;                                /**< The isa about which everything is. */
 526
 527   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 528                                                            a stack. */
 529
 530   int handlers_tos;                                   /**< The stack pointer of the handler
 531                                                         stack. */
 532 };
 533
 534 /**
 535  * Get the isa of an arch environment.
 536  * @param env The environment.
 537  * @return The isa with which the env was initialized with.
 538  */
 539 #define arch_env_get_isa(env)   ((env)->isa)
 540
 541 /**
 542  * Initialize the architecture environment struct.
 543  * @param isa The isa which shall be put into the environment.
 544  * @return The environment.
 545  */
 546 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
 547
 548 /**
 549  * Add a node handler to the environment.
 550  * @param env The environment.
 551  * @param handler A node handler.
 552  * @return The environment itself.
 553  */
 554 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
 555     const arch_irn_handler_t *handler);
 556
 557 #endif /* _FIRM_BEARCH_H */