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