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