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

   1 #ifndef _FIRM_BEARCH_H
   2 #define _FIRM_BEARCH_H
   3
   4 #include "firm_config.h"
   5
   6 #ifdef WITH_LIBCORE
   7 #include <libcore/lc_opts.h>
   8 #endif
   9
  10 #include "firm_types.h"
  11
  12 #include "bitset.h"
  13
  14 #include "belistsched.h"
  15 #include "beilpsched.h"
  16 #include "beabi_t.h"
  17 #include "bearch_t.h"
  18 #include "be_t.h"
  19 #include "bemachine.h"
  20 #include "beirg.h"
  21
  22 struct _be_node_factory_t;
  23
  24 typedef enum _arch_register_type_t {
  25   arch_register_type_none         = 0,
  26   arch_register_type_caller_save  = 1,  /**< The register must be saved by the caller
  27                                              upon a function call. It thus can be overwritten
  28                                              in the called function. */
  29   arch_register_type_callee_save  = 2,  /**< The register must be saved by the caller
  30                                              upon a function call. It thus can be overwritten
  31                                              in the called function. */
  32   arch_register_type_ignore       = 4,  /**< Do not consider this register when allocating. */
  33   arch_register_type_joker        = 8,  /**< The emitter can choose an arbitrary register */
  34   arch_register_type_virtual      = 16, /**< This is just a virtual register  */
  35 } arch_register_type_t;
  36
  37 /**
  38  * Convenience macro to check for register type.
  39  * @param req   A pointer to register.
  40  * @param kind  The kind of type to check for (see arch_register_type_t).
  41  * @return      1, If register is of given kind, 0 if not.
  42  */
  43 #define arch_register_type_is(reg, kind) \
  44   (((reg)->type & arch_register_type_ ## kind) != 0)
  45
  46 /**
  47  * A register.
  48  */
  49 struct _arch_register_t {
  50   const char                  *name;        /**< The name of the register. */
  51   const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  52   int                         index;        /**< The index of the register in the class. */
  53   arch_register_type_t        type;         /**< The type of the register. */
  54   void                        *data;        /**< Custom data. */
  55 };
  56
  57 static INLINE const arch_register_class_t *
  58 _arch_register_get_class(const arch_register_t *reg)
  59 {
  60   return reg->reg_class;
  61 }
  62
  63 static INLINE int _arch_register_get_index(const arch_register_t *reg)
  64 {
  65   return reg->index;
  66 }
  67
  68 static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
  69 {
  70         return reg->name;
  71 }
  72
  73 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  74 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  75 #define arch_register_get_name(reg)       _arch_register_get_name(reg)
  76
  77 /**
  78  * A class of registers.
  79  * Like general purpose or floating point.
  80  */
  81 struct _arch_register_class_t {
  82   const char *name;               /**< The name of the register class. */
  83   int n_regs;                     /**< Number of registers in this class. */
  84   ir_mode *mode;                  /**< The mode of the register class. */
  85   const arch_register_t *regs;    /**< The array of registers. */
  86 };
  87
  88 /** return the number of registers in this register class */
  89 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  90
  91 /** return the largest mode of this register class */
  92 #define arch_register_class_mode(cls) ((cls)->mode)
  93
  94 /** return the name of this register class */
  95 #define arch_register_class_name(cls) ((cls)->name)
  96
  97 /**
  98  * Put all registers in a class into a bitset.
  99  * @param cls The class.
 100  * @param bs The bitset. May be NULL.
 101  * @return The number of registers in the class.
 102  */
 103 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
 104
 105 static INLINE const arch_register_t *
 106 _arch_register_for_index(const arch_register_class_t *cls, int idx)
 107 {
 108   assert(0 <= idx && idx < cls->n_regs);
 109   return &cls->regs[idx];
 110 }
 111
 112 #define arch_register_for_index(cls, idx) \
 113   _arch_register_for_index(cls, idx)
 114
 115 typedef enum _arch_operand_type_t {
 116   arch_operand_type_invalid,
 117   arch_operand_type_memory,
 118   arch_operand_type_register,
 119   arch_operand_type_immediate,
 120   arch_operand_type_symconst,
 121   arch_operand_type_last
 122 } arch_operand_type_t;
 123
 124 /**
 125  * Different types of register allocation requirements.
 126  */
 127 typedef enum _arch_register_req_type_t {
 128         arch_register_req_type_none                         = 0,  /**< No register requirement. */
 129         arch_register_req_type_normal                       = 1,  /**< All registers in the class are allowed. */
 130         arch_register_req_type_limited                      = 2,  /**< Only a real subset of the class is allowed. */
 131         arch_register_req_type_should_be_same               = 4,  /**< The register should be equal another one at the node. */
 132         arch_register_req_type_should_be_different          = 8,  /**< The register must be unequal to some other at the node. */
 133         arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from all in's at the node */
 134 } arch_register_req_type_t;
 135
 136 /**
 137  * Convenience macro to check for set constraints.
 138  * @param req   A pointer to register requirements.
 139  * @param kind  The kind of constraint to check for (see arch_register_req_type_t).
 140  * @return      1, If the kind of constraint is present, 0 if not.
 141  */
 142 #define arch_register_req_is(req, kind) \
 143         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 144
 145 /**
 146  * Expresses requirements to register allocation for an operand.
 147  */
 148 typedef struct _arch_register_req_t {
 149         arch_register_req_type_t type;          /**< The type of the constraint. */
 150         const arch_register_class_t *cls;       /**< The register class this constraint belongs to. */
 151
 152         void (*limited)(void *limited_env, bitset_t *bs);
 153                                           /**< In case of the 'limited'
 154                                             constraint, this function
 155                                             must put all allowable
 156                                             registers in the bitset and
 157                                             return the number of registers
 158                                             in the bitset. */
 159
 160         void *limited_env;                    /**< This must passed to limited. */
 161
 162         ir_node *other_same;                      /**< The other which shall have the same reg
 163                                                                                     as this one. (for case should_be_same). */
 164
 165         ir_node *other_different;             /**< The other node from which this one's register
 166                                                                                     must be different (case must_be_different). */
 167 } arch_register_req_t;
 168
 169 /**
 170  * Format a register requirements information into a string.
 171  * @param buf The string where to put it to.
 172  * @param len The size of @p buf.
 173  * @param req The requirements structure to format.
 174  * @return    A pointer to buf.
 175  */
 176 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
 177
 178
 179 /**
 180  * Certain node classes which are relevant for the register allocator.
 181  */
 182 typedef enum _arch_irn_class_t {
 183         arch_irn_class_normal     = 1 << 0,
 184         arch_irn_class_spill      = 1 << 1,
 185         arch_irn_class_reload     = 1 << 2,
 186         arch_irn_class_copy       = 1 << 3,
 187         arch_irn_class_perm       = 1 << 4,
 188         arch_irn_class_branch     = 1 << 5,
 189         arch_irn_class_call       = 1 << 6,
 190         arch_irn_class_const      = 1 << 7,
 191         arch_irn_class_load       = 1 << 8,
 192         arch_irn_class_store      = 1 << 9,
 193         arch_irn_class_stackparam = 1 << 10,
 194 } arch_irn_class_t;
 195
 196 /**
 197  * An inverse operation returned by the backend
 198  */
 199 typedef struct _arch_inverse_t {
 200         int      n;       /**< count of nodes returned in nodes array */
 201         int      costs;   /**< costs of this remat */
 202
 203         /**< nodes for this inverse operation. shall be in
 204          *  schedule order. last element is the target value
 205          */
 206         ir_node  **nodes;
 207 } arch_inverse_t;
 208
 209 /**
 210  * Some flags describing a node in more detail.
 211  */
 212 typedef enum _arch_irn_flags_t {
 213         arch_irn_flags_none             = 0, /**< Node flags. */
 214         arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
 215         arch_irn_flags_rematerializable = 2, /**< This can be replicated instead of spilled/reloaded. */
 216         arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
 217         arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
 218         arch_irn_flags_last             = arch_irn_flags_modify_sp
 219 } arch_irn_flags_t;
 220
 221 /**
 222  * Get the string representation of a flag.
 223  * This functions does not handle or'ed bitmasks of flags.
 224  * @param flag The flag.
 225  * @return The flag as a string.
 226  */
 227 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
 228
 229 struct _arch_irn_ops_if_t {
 230
 231   /**
 232    * Get the register requirements for a given operand.
 233    * @param self The self pointer.
 234    * @param irn The node.
 235    * @param pos The operand's position
 236    *        (-1 for the result of the node, 0..n for the input operands).
 237    * @return    The register requirements for the selected operand.
 238    *            The pointer returned is never NULL.
 239    */
 240   const arch_register_req_t *(*get_irn_reg_req)(const void *self,
 241       arch_register_req_t *req, const ir_node *irn, int pos);
 242
 243   /**
 244    * Set the register for an output operand.
 245    * @param irn The node.
 246    * @param reg The register allocated to that operand.
 247    * @note      If the operand is not a register operand,
 248    *            the call is ignored.
 249    */
 250   void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 251
 252   /**
 253    * Get the register allocated for an output operand.
 254    * @param irn The node.
 255    * @return    The register allocated at that operand. NULL, if
 256    *            the operand was no register operand or
 257    *            @c arch_register_invalid, if no register has yet been
 258    *            allocated for this node.
 259    */
 260   const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 261
 262   /**
 263    * Classify the node.
 264    * @param irn The node.
 265    * @return A classification.
 266    */
 267   arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 268
 269   /**
 270    * Get the flags of a node.
 271    * @param self The irn ops themselves.
 272    * @param irn The node.
 273    * @return A set of flags.
 274    */
 275   arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 276
 277   /**
 278    * Get the entity on the stack frame this node depends on.
 279    * @param self The this pointer.
 280    * @param irn  The node in question.
 281    * @return The entity on the stack frame or NULL, if the node does not have a
 282    *         stack frame entity.
 283    */
 284   ir_entity *(*get_frame_entity)(const void *self, const ir_node *irn);
 285
 286   /**
 287    * Set the entity on the stack frame this node depends on.
 288    * @param self The this pointer.
 289    * @param irn  The node in question.
 290    * @param ent  The entity to set
 291    */
 292   void (*set_frame_entity)(const void *self, ir_node *irn, ir_entity *ent);
 293
 294   /**
 295    * Set the offset of a node carrying an entity on the stack frame.
 296    * @param self The this pointer.
 297    * @param irn  The node.
 298    * @param offset The offset of the node's stack frame entity.
 299    */
 300   void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
 301
 302   /**
 303    * Returns the delta of the stackpointer for nodes that increment or
 304    * decrement the stackpointer with a constant value. (push, pop
 305    * nodes on most architectures).
 306    * A positive value stands for an expanding stack area, a negative value for
 307    * a shrinking one.
 308    *
 309    * @param self      The this pointer
 310    * @param irn       The node
 311    * @return          0 if the stackpointer is not modified with a constant
 312    *                  value, otherwise the increment/decrement value
 313    */
 314   int (*get_sp_bias)(const void *self, const ir_node *irn);
 315
 316   /**
 317    * Returns an inverse operation which yields the i-th argument
 318    * of the given node as result.
 319    *
 320    * @param self      The this pointer.
 321    * @param irn       The original operation
 322    * @param i         Index of the argument we want the inverse operation to yield
 323    * @param inverse   struct to be filled with the resulting inverse op
 324    * @param obstack   The obstack to use for allocation of the returned nodes array
 325    * @return          The inverse operation or NULL if operation invertible
 326    */
 327   arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
 328
 329   /**
 330    * Get the estimated cycle count for @p irn.
 331    *
 332    * @param self The this pointer.
 333    * @param irn  The node.
 334    *
 335    * @return     The estimated cycle count for this operation
 336    */
 337   int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
 338
 339   /**
 340    * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
 341    *
 342    * @param self The this pointer.
 343    * @param irn  The node.
 344    * @param i    Index of the argument we would like to know whether @p irn can load it form memory internally
 345    *
 346    * @return     nonzero if argument can be loaded or zero otherwise
 347    */
 348   int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
 349
 350   /**
 351    * Ask the backend to assimilate @p reload of operand @p i into @p irn.
 352    *
 353    * @param self   The this pointer.
 354    * @param irn    The node.
 355    * @param spill  The spill.
 356    * @param i      The position of the reload.
 357    */
 358   void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
 359 };
 360
 361 /**
 362  * irn_ops base class.
 363  */
 364 struct _arch_irn_ops_t {
 365         const arch_irn_ops_if_t *impl;
 366 };
 367
 368 extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
 369
 370 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
 371
 372 extern ir_entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
 373 extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, ir_entity *ent);
 374 extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
 375
 376 extern int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn);
 377 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);
 378 extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
 379 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
 380
 381 /**
 382  * Get the register requirements for a node.
 383  * @param env The architecture environment.
 384  * @param req A pointer to a requirements structure, where the data can
 385  *            be put into.
 386  * @param irn The node.
 387  * @param pos The position of the operand you're interested in.
 388  * @return    A pointer to the register requirements which may <b>not</b>
 389  *            neccessarily be equal to @p req. If NULL is returned, the
 390  *            operand was no register operand.
 391  */
 392 extern const arch_register_req_t *
 393 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 394     const ir_node *irn, int pos);
 395
 396 /**
 397  * Check if an operand is a register operand.
 398  * @param env The environment.
 399  * @param irn The node.
 400  * @param pos The position of the operand.
 401  * @return 1, if the operand is significant for register allocation, 0
 402  * if not.
 403  */
 404 extern int arch_is_register_operand(const arch_env_t *env,
 405     const ir_node *irn, int pos);
 406
 407 /**
 408  * Get the number of allocatable registers concerning
 409  * a register class for an operand of a node.
 410  * @param env The environment.
 411  * @param irn The node.
 412  * @param pos The postition of the node's operand.
 413  * @param bs  The bitset all allocatable registers shall be put into.
 414  *            Note, that you can also pass NULL here. If you don't,
 415  *            make sure, the bitset is as large as the register class
 416  *            has registers.
 417  * @return    The amount of registers allocatable for that operand.
 418  */
 419 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
 420
 421 /**
 422  * Put all registers which shall not be ignored by the register
 423  * allocator in a bit set.
 424  * @param env The arch env.
 425  * @param cls The register class to consider.
 426  * @param bs  The bit set to put the registers to.
 427  */
 428 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
 429
 430 /**
 431  * Check, if a register is assignable to an operand of a node.
 432  * @param env The architecture environment.
 433  * @param irn The node.
 434  * @param pos The position of the operand.
 435  * @param reg The register.
 436  * @return    1, if the register might be allocated to the operand 0 if not.
 437  */
 438 extern int arch_reg_is_allocatable(const arch_env_t *env,
 439     const ir_node *irn, int pos, const arch_register_t *reg);
 440
 441 /**
 442  * Get the register class of an operand of a node.
 443  * @param env The architecture environment.
 444  * @param irn The node.
 445  * @param pos The position of the operand, -1 for the output.
 446  * @return    The register class of the operand or NULL, if
 447  *            operand is a non-register operand.
 448  */
 449 extern const arch_register_class_t *
 450 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 451
 452 /**
 453  * Get the register allocated at a certain output operand of a node.
 454  * @param env The arch environment.
 455  * @param irn The node.
 456  * @return    The register allocated for this operand
 457  */
 458 extern const arch_register_t *
 459 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 460
 461 /**
 462  * Set the register for a certain output operand.
 463  * @param env The architecture environment.
 464  * @param irn The node.
 465  * @param idx The index of the output operand.
 466  * @param reg The register.
 467  */
 468 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 469                 const arch_register_t *reg);
 470
 471 /**
 472  * Classify a node.
 473  * @param env The architecture environment.
 474  * @param irn The node.
 475  * @return A classification of the node.
 476  */
 477 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 478
 479 #define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
 480
 481 /**
 482  * Get the flags of a node.
 483  * @param env The architecture environment.
 484  * @param irn The node.
 485  * @return The flags.
 486  */
 487 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 488
 489 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
 490
 491 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 492         ((cls) == arch_get_irn_reg_class(env, irn, pos))
 493
 494 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
 495         (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
 496
 497 /**
 498  * Somebody who can be asked about IR nodes.
 499  */
 500 struct _arch_irn_handler_t {
 501
 502   /**
 503     * Get the operations of an irn.
 504     * @param self The handler from which the method is invoked.
 505     * @param irn Some node.
 506     * @return Operations for that irn.
 507     */
 508   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
 509       const ir_node *irn);
 510 };
 511
 512 /**
 513  * The code generator interface.
 514  */
 515 struct _arch_code_generator_if_t {
 516         /**
 517          * Initialize the code generator.
 518          * @param birg A backend IRG session.
 519          * @return     A newly created code generator.
 520          */
 521         void *(*init)(be_irg_t *birg);
 522
 523         /**
 524          * Called before abi introduce.
 525          */
 526         void (*before_abi)(void *self);
 527
 528         /**
 529          * Called, when the graph is being normalized.
 530          */
 531         void (*prepare_graph)(void *self);
 532
 533         /**
 534          * Backend may provide an own spiller.
 535          * This spiller needs to spill all register classes.
 536          */
 537         void (*spill)(void *self, be_irg_t *birg);
 538
 539         /**
 540          * Called before scheduling.
 541          */
 542         void (*before_sched)(void *self);
 543
 544         /**
 545          * Called before register allocation.
 546          */
 547         void (*before_ra)(void *self);
 548
 549         /**
 550          * Called after register allocation.
 551          */
 552         void (*after_ra)(void *self);
 553
 554         /**
 555          * Called directly before done is called. This should be the last place
 556          * where the irg is modified.
 557          */
 558         void (*finish)(void *self);
 559
 560         /**
 561          * Called after everything happened. This call should emit the final
 562          * assembly code but avoid changing the irg.
 563          * The code generator must also be de-allocated here.
 564          */
 565         void (*done)(void *self);
 566 };
 567
 568 /**
 569  * helper macro: call function func from the code generator
 570  * if it's implemented.
 571  */
 572 #define _arch_cg_call(cg, func) \
 573 do { \
 574         if((cg)->impl->func) \
 575                 (cg)->impl->func(cg); \
 576 } while(0)
 577
 578 #define _arch_cg_call_env(cg, env, func) \
 579 do { \
 580         if((cg)->impl->func) \
 581                 (cg)->impl->func(cg, env); \
 582 } while(0)
 583
 584 #define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 585 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 586 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 587 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 588 #define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 589 #define arch_code_generator_finish(cg)          _arch_cg_call(cg, finish)
 590 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 591 #define arch_code_generator_spill(cg, birg)     _arch_cg_call_env(cg, birg, spill)
 592 #define arch_code_generator_has_spiller(cg)     ((cg)->impl->spill != NULL)
 593
 594 /**
 595  * Code generator base class.
 596  */
 597 struct _arch_code_generator_t {
 598         const arch_code_generator_if_t *impl;
 599 };
 600
 601 /**
 602  * ISA base class.
 603  */
 604 struct _arch_isa_t {
 605         const arch_isa_if_t   *impl;
 606         const arch_register_t *sp;        /** The stack pointer register. */
 607         const arch_register_t *bp;        /** The base pointer register. */
 608         const int             stack_dir;  /** -1 for decreasing, 1 for increasing. */
 609         const be_main_env_t   *main_env;  /** the be main environment */
 610 };
 611
 612 #define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
 613 #define arch_isa_sp(isa)         ((isa)->sp)
 614 #define arch_isa_bp(isa)         ((isa)->bp)
 615
 616 /**
 617  * Architecture interface.
 618  */
 619 struct _arch_isa_if_t {
 620         /**
 621          * Initialize the isa interface.
 622          * @param file_handle  the file handle to write the output to
 623          * @param main_env     the be main environment
 624          * @return a new isa instance
 625          */
 626         void *(*init)(FILE *file_handle);
 627
 628         /**
 629          * Free the isa instance.
 630          */
 631         void (*done)(void *self);
 632
 633         /**
 634          * Get the the number of register classes in the isa.
 635          * @return The number of register classes.
 636          */
 637         int (*get_n_reg_class)(const void *self);
 638
 639         /**
 640          * Get the i-th register class.
 641          * @param i The number of the register class.
 642          * @return The register class.
 643          */
 644         const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 645
 646         /**
 647          * Get the register class which shall be used to store a value of a given mode.
 648          * @param self The this pointer.
 649          * @param mode The mode in question.
 650          * @return A register class which can hold values of the given mode.
 651          */
 652         const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
 653
 654         /**
 655          * Get the ABI restrictions for procedure calls.
 656          * @param self        The this pointer.
 657          * @param method_type The type of the method (procedure) in question.
 658          * @param p           The array of parameter locations to be filled.
 659          */
 660         void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
 661
 662         /**
 663          * The irn handler for this architecture.
 664          * The irn handler is registered by the Firm back end
 665          * when the architecture is initialized.
 666          * (May be NULL).
 667          */
 668         const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 669
 670         /**
 671          * Get the code generator interface.
 672          * @param self The this pointer.
 673          * @return     Some code generator interface.
 674          */
 675         const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 676
 677         /**
 678          * Get the list scheduler to use. There is already a selector given, the
 679          * backend is free to modify and/or ignore it.
 680          *
 681          * @param self     The isa object.
 682          * @param selector The selector given by options.
 683          * @return         The list scheduler selector.
 684          */
 685         const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
 686
 687         /**
 688          * Get the ILP scheduler to use.
 689          * @param self  The isa object.
 690          * @return      The ILP scheduler selector
 691          */
 692         const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
 693
 694         /**
 695          * Get the necessary alignment for storing a register of given class.
 696          * @param self  The isa object.
 697          * @param cls   The register class.
 698          * @return      The alignment in bytes.
 699          */
 700         int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
 701
 702         /**
 703          * A "static" function, returns the frontend settings
 704          * needed for this backend.
 705          */
 706         const backend_params *(*get_params)(void);
 707
 708         /**
 709          * Returns an 2-dim array of execution units, @p irn can be executed on.
 710          * The first dimension is the type, the second the allowed units of this type.
 711          * Each dimension is a NULL terminated list.
 712          * @param self  The isa object.
 713          * @param irn   The node.
 714          * @return An array of allowed execution units.
 715          *         exec_unit = {
 716          *                       { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
 717          *                       ...,
 718          *                       { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
 719          *                       NULL
 720          *                     };
 721          */
 722         const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
 723
 724         /**
 725          * Return the abstract machine for this isa.
 726          * @param self  The isa object.
 727          */
 728         const be_machine_t *(*get_machine)(const void *self);
 729
 730         /**
 731          * Return an ordered list of irgs where code should be generated for.
 732          * If NULL is returned, all irg will be taken into account and they will be
 733          * generated in an arbitrary order.
 734          * @param self   The isa object.
 735          * @param irgs   A flexible array ARR_F of length 0 where the backend cann append the desired irgs.
 736          * @return A flexible array ARR_F containing all desired irgs in the desired order.
 737          */
 738         ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
 739 };
 740
 741 #define arch_isa_get_n_reg_class(isa)                  ((isa)->impl->get_n_reg_class(isa))
 742 #define arch_isa_get_reg_class(isa,i)                  ((isa)->impl->get_reg_class(isa, i))
 743 #define arch_isa_get_irn_handler(isa)                  ((isa)->impl->get_irn_handler(isa))
 744 #define arch_isa_get_call_abi(isa,tp,abi)              ((isa)->impl->get_call_abi((isa), (tp), (abi)))
 745 #define arch_isa_get_reg_class_for_mode(isa,mode)      ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
 746 #define arch_isa_make_code_generator(isa,irg)          ((isa)->impl->make_code_generator((isa), (irg)))
 747 #define arch_isa_get_reg_class_alignment(isa, cls)     ((isa)->impl->get_reg_class_alignment((isa), (cls)))
 748 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
 749 #define arch_isa_get_machine(isa)                      ((isa)->impl->get_machine((isa)))
 750 #define arch_isa_get_backend_irg_list(isa, irgs)       ((isa)->impl->get_backend_irg_list((isa), (irgs)))
 751
 752 #define ARCH_MAX_HANDLERS         8
 753
 754 /**
 755  * Environment for the architecture infrastructure.
 756  * Keep this everywhere you're going.
 757  */
 758 struct _arch_env_t {
 759   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 760   arch_isa_t *isa;                                /**< The isa about which everything is. */
 761
 762   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 763                                                            a stack. */
 764
 765   int handlers_tos;                                   /**< The stack pointer of the handler
 766                                                         stack. */
 767 };
 768
 769 /**
 770  * Get the isa of an arch environment.
 771  * @param env The environment.
 772  * @return The isa with which the env was initialized with.
 773  */
 774 #define arch_env_get_isa(env)   ((env)->isa)
 775
 776 /**
 777  * Initialize the architecture environment struct.
 778  * @param isa           The isa which shall be put into the environment.
 779  * @param file_handle   The file handle
 780  * @return The environment.
 781  */
 782 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle, be_main_env_t *main_env);
 783
 784 /**
 785  * Add a node handler to the environment.
 786  * @param env The environment.
 787  * @param handler A node handler.
 788  * @return The environment itself.
 789  */
 790 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
 791
 792 /**
 793  * Remove a node handler from the handler stack.
 794  * @param env The architecture environment.
 795  * @return The popped handler.
 796  */
 797 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 798
 799 /**
 800  * Register an instruction set architecture
 801  */
 802 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
 803
 804 #endif /* _FIRM_BEARCH_H */