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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Processor architecture specification.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BEARCH_H
  27 #define FIRM_BE_BEARCH_H
  28
  29 #include <stdbool.h>
  30
  31 #include "firm_types.h"
  32 #include "bitset.h"
  33 #include "obst.h"
  34 #include "raw_bitset.h"
  35 #include "irop_t.h"
  36
  37 #include "be_types.h"
  38 #include "beinfo.h"
  39 #include "be.h"
  40 #include "beirg.h"
  41 #include "error.h"
  42
  43 typedef enum arch_register_class_flags_t {
  44         arch_register_class_flag_none      = 0,
  45         /** don't do automatic register allocation for this class */
  46         arch_register_class_flag_manual_ra = 1U << 0,
  47         /** the register models an abstract state (example: fpu rounding mode) */
  48         arch_register_class_flag_state     = 1U << 1
  49 } arch_register_class_flags_t;
  50
  51 typedef enum arch_register_type_t {
  52         arch_register_type_none         = 0,
  53         /** The register must be saved by the caller upon a function call. It thus
  54          * can be overwritten in the called function. */
  55         arch_register_type_caller_save  = 1U << 0,
  56         /** The register must be saved by the caller upon a function call. It thus
  57          * can be overwritten in the called function. */
  58         arch_register_type_callee_save  = 1U << 1,
  59         /** Do not consider this register when allocating. */
  60         arch_register_type_ignore       = 1U << 2,
  61         /** The emitter can choose an arbitrary register. The register fulfills any
  62          * register constraints as long as the register class matches */
  63         arch_register_type_joker        = 1U << 3,
  64         /** This is just a virtual register. Virtual registers fulfill any register
  65          * constraints as long as the register class matches. It is a allowed to
  66          * have multiple definitions for the same virtual register at a point */
  67         arch_register_type_virtual      = 1U << 4,
  68         /** The register represents a state that should be handled by bestate
  69          * code */
  70         arch_register_type_state        = 1U << 5,
  71 } arch_register_type_t;
  72
  73 /**
  74  * Different types of register allocation requirements.
  75  */
  76 typedef enum arch_register_req_type_t {
  77         /** No register requirement. */
  78         arch_register_req_type_none              = 0,
  79         /** All registers in the class are allowed. */
  80         arch_register_req_type_normal            = 1U << 0,
  81         /** Only a real subset of the class is allowed. */
  82         arch_register_req_type_limited           = 1U << 1,
  83         /** The register should be equal to another one at the node. */
  84         arch_register_req_type_should_be_same    = 1U << 2,
  85         /** The register must be unequal from some other at the node. */
  86         arch_register_req_type_must_be_different = 1U << 3,
  87         /** The registernumber should be aligned (in case of multiregister values)*/
  88         arch_register_req_type_aligned           = 1U << 4,
  89         /** ignore while allocating registers */
  90         arch_register_req_type_ignore            = 1U << 5,
  91         /** the output produces a new value for the stack pointer
  92          * (this is not really a constraint but a marker to guide the stackpointer
  93          * rewiring logic) */
  94         arch_register_req_type_produces_sp       = 1U << 6,
  95 } arch_register_req_type_t;
  96
  97 extern const arch_register_req_t *arch_no_register_req;
  98
  99 /**
 100  * Print information about a register requirement in human readable form
 101  * @param F   output stream/file
 102  * @param req The requirements structure to format.
 103  */
 104 void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
 105                             const ir_node *node);
 106
 107 void arch_dump_register_reqs(FILE *F, const ir_node *node);
 108 void arch_dump_reqs_and_registers(FILE *F, const ir_node *node);
 109
 110 /**
 111  * Node classification. Used for statistics and for detecting reload nodes.
 112  */
 113 typedef enum arch_irn_class_t {
 114         arch_irn_class_spill  = 1 << 0,
 115         arch_irn_class_reload = 1 << 1,
 116         arch_irn_class_remat  = 1 << 2,
 117         arch_irn_class_copy   = 1 << 3,
 118         arch_irn_class_perm   = 1 << 4
 119 } arch_irn_class_t;
 120
 121 void arch_set_frame_offset(ir_node *irn, int bias);
 122
 123 ir_entity *arch_get_frame_entity(const ir_node *irn);
 124 int        arch_get_sp_bias(ir_node *irn);
 125
 126 int             arch_get_op_estimated_cost(const ir_node *irn);
 127 arch_inverse_t *arch_get_inverse(const ir_node *irn, int i,
 128                                  arch_inverse_t *inverse,
 129                                  struct obstack *obstack);
 130 int             arch_possible_memory_operand(const ir_node *irn,
 131                                              unsigned int i);
 132 void            arch_perform_memory_operand(ir_node *irn, ir_node *spill,
 133                                             unsigned int i);
 134
 135 /**
 136  * Get the register requirements for a node.
 137  * @note Deprecated API! Preferably use
 138  *       arch_get_in_register_req and
 139  *       arch_get_out_register_req.
 140  *
 141  * @param irn The node.
 142  * @param pos The position of the operand you're interested in.
 143  * @return    A pointer to the register requirements.  If NULL is returned, the
 144  *            operand was no register operand.
 145  */
 146 const arch_register_req_t *arch_get_register_req(const ir_node *irn, int pos);
 147
 148 /**
 149  * Put all registers which shall not be ignored by the register
 150  * allocator in a bit set.
 151  * @param cls The register class to consider.
 152  * @param bs  The bit set to put the registers to.
 153  */
 154 extern void arch_put_non_ignore_regs(const arch_register_class_t *cls,
 155                                      bitset_t *bs);
 156
 157 /**
 158  * Check, if a register is assignable to an operand of a node.
 159  * @param irn The node.
 160  * @param pos The position of the operand.
 161  * @param reg The register.
 162  * @return    1, if the register might be allocated to the operand 0 if not.
 163  */
 164 int arch_reg_is_allocatable(const ir_node *irn, int pos,
 165                             const arch_register_t *reg);
 166
 167 #define arch_reg_out_is_allocatable(irn, reg) arch_reg_is_allocatable(irn, -1, reg)
 168
 169 /**
 170  * Get the register class of an operand of a node.
 171  * @param irn The node.
 172  * @param pos The position of the operand, -1 for the output.
 173  * @return    The register class of the operand or NULL, if
 174  *            operand is a non-register operand.
 175  */
 176 const arch_register_class_t *arch_get_irn_reg_class(const ir_node *irn,
 177                                                     int pos);
 178
 179 #define arch_get_irn_reg_class_out(irn) arch_get_irn_reg_class(irn, -1)
 180
 181 /**
 182  * Get the register allocated at a certain output operand of a node.
 183  * @param irn The node.
 184  * @return    The register allocated for this operand
 185  */
 186 const arch_register_t *arch_get_irn_register(const ir_node *irn);
 187 const arch_register_t *arch_irn_get_register(const ir_node *irn, int pos);
 188
 189 /**
 190  * Set the register for a certain output operand.
 191  * @param irn The node.
 192  * @param reg The register.
 193  */
 194 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
 195 void arch_irn_set_register(ir_node *irn, int pos, const arch_register_t *reg);
 196
 197 /**
 198  * Classify a node.
 199  * @param irn The node.
 200  * @return A classification of the node.
 201  */
 202 arch_irn_class_t arch_irn_classify(const ir_node *irn);
 203
 204 /**
 205  * Get the flags of a node.
 206  * @param irn The node.
 207  * @return The flags.
 208  */
 209 arch_irn_flags_t arch_irn_get_flags(const ir_node *irn);
 210
 211 void arch_irn_set_flags(ir_node *node, arch_irn_flags_t flags);
 212 void arch_irn_add_flags(ir_node *node, arch_irn_flags_t flags);
 213
 214 #define arch_irn_is(irn, flag) ((arch_irn_get_flags(irn) & arch_irn_flags_ ## flag) != 0)
 215
 216 /**
 217  * Get the operations of an irn.
 218  * @param self The handler from which the method is invoked.
 219  * @param irn Some node.
 220  * @return Operations for that irn.
 221  */
 222 typedef const void *(arch_get_irn_ops_t)(const ir_node *irn);
 223
 224 /**
 225  * Initialize the architecture environment struct.
 226  * @param isa           The isa which shall be put into the environment.
 227  * @param file_handle   The file handle
 228  * @return The environment.
 229  */
 230 extern arch_env_t *arch_env_init(const arch_isa_if_t *isa,
 231                                  FILE *file_handle, be_main_env_t *main_env);
 232
 233 /**
 234  * Register an instruction set architecture
 235  */
 236 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
 237
 238 /**
 239  * A register.
 240  */
 241 struct arch_register_t {
 242         const char                  *name;       /**< The name of the register. */
 243         const arch_register_class_t *reg_class;  /**< The class of the register */
 244         unsigned                     index;      /**< The index of the register in
 245                                                       the class. */
 246         arch_register_type_t         type;       /**< The type of the register. */
 247         /** register constraint allowing just this register */
 248         const arch_register_req_t   *single_req;
 249 };
 250
 251 static inline const arch_register_class_t *_arch_register_get_class(
 252                 const arch_register_t *reg)
 253 {
 254         return reg->reg_class;
 255 }
 256
 257 static inline unsigned _arch_register_get_index(const arch_register_t *reg)
 258 {
 259         return reg->index;
 260 }
 261
 262 static inline const char *_arch_register_get_name(const arch_register_t *reg)
 263 {
 264         return reg->name;
 265 }
 266
 267 #define arch_register_get_class(reg)        _arch_register_get_class(reg)
 268 #define arch_register_get_index(reg)        _arch_register_get_index(reg)
 269 #define arch_register_get_name(reg)         _arch_register_get_name(reg)
 270
 271 /**
 272  * Convenience macro to check for register type.
 273  * @param req   A pointer to register.
 274  * @param kind  The kind of type to check for (see arch_register_type_t).
 275  * @return      1, If register is of given kind, 0 if not.
 276  */
 277 #define arch_register_type_is(reg, kind) \
 278   (((reg)->type & arch_register_type_ ## kind) != 0)
 279
 280 /**
 281  * A class of registers.
 282  * Like general purpose or floating point.
 283  */
 284 struct arch_register_class_t {
 285         unsigned                     index;   /**< index of this register class */
 286         const char                  *name;    /**< The name of the register class.*/
 287         unsigned                     n_regs;  /**< Number of registers in this
 288                                                    class. */
 289         ir_mode                     *mode;    /**< The mode of the register class.*/
 290         const arch_register_t       *regs;    /**< The array of registers. */
 291         arch_register_class_flags_t  flags;   /**< register class flags. */
 292         const arch_register_req_t   *class_req;
 293 };
 294
 295 /** return the number of registers in this register class */
 296 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
 297
 298 /** return the largest mode of this register class */
 299 #define arch_register_class_mode(cls) ((cls)->mode)
 300
 301 /** return the name of this register class */
 302 #define arch_register_class_name(cls) ((cls)->name)
 303
 304 /** return the index of this register class */
 305 #define arch_register_class_index(cls)  ((cls)->index)
 306
 307 /** return the register class flags */
 308 #define arch_register_class_flags(cls) ((cls)->flags)
 309
 310 static inline const arch_register_t *_arch_register_for_index(
 311                 const arch_register_class_t *cls, unsigned idx)
 312 {
 313         assert(idx < cls->n_regs);
 314         return &cls->regs[idx];
 315 }
 316
 317 #define arch_register_for_index(cls, idx)   _arch_register_for_index(cls, idx)
 318
 319 /**
 320  * Convenience macro to check for set constraints.
 321  * @param req   A pointer to register requirements.
 322  * @param kind  The kind of constraint to check for
 323  *              (see arch_register_req_type_t).
 324  * @return      1, If the kind of constraint is present, 0 if not.
 325  */
 326 #define arch_register_req_is(req, kind) \
 327         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 328
 329 /**
 330  * Expresses requirements to register allocation for an operand.
 331  */
 332 struct arch_register_req_t {
 333         arch_register_req_type_t     type; /**< The type of the constraint. */
 334         const arch_register_class_t *cls;  /**< The register class this constraint
 335                                                 belongs to. */
 336         const unsigned *limited;            /**< allowed register bitset */
 337         unsigned other_same;                /**< Bitmask of ins which should use the
 338                                                  same register (should_be_same). */
 339         unsigned other_different;           /**< Bitmask of ins which shall use a
 340                                                  different register
 341                                                  (must_be_different) */
 342         unsigned char width;                /**< specifies how many sequential
 343                                                  registers are required */
 344 };
 345
 346 static inline int reg_reqs_equal(const arch_register_req_t *req1,
 347                                  const arch_register_req_t *req2)
 348 {
 349         if (req1 == req2)
 350                 return 1;
 351
 352         if (req1->type != req2->type
 353                         || req1->cls != req2->cls
 354                         || req1->other_same != req2->other_same
 355                         || req1->other_different != req2->other_different)
 356                 return 0;
 357
 358         if (req1->limited != NULL) {
 359                 size_t n_regs;
 360
 361                 if (req2->limited == NULL)
 362                         return 0;
 363
 364                 n_regs = arch_register_class_n_regs(req1->cls);
 365                 if (!rbitsets_equal(req1->limited, req2->limited, n_regs))
 366                         return 0;
 367         }
 368
 369         return 1;
 370 }
 371
 372 /**
 373  * An inverse operation returned by the backend
 374  */
 375 struct arch_inverse_t {
 376         int      n;       /**< count of nodes returned in nodes array */
 377         int      costs;   /**< costs of this remat */
 378
 379         /** nodes for this inverse operation. shall be in schedule order.
 380          * last element is the target value */
 381         ir_node  **nodes;
 382 };
 383
 384 struct arch_irn_ops_t {
 385
 386         /**
 387          * Get the register requirements for a given operand.
 388          * @param irn The node.
 389          * @param pos The operand's position
 390          * @return    The register requirements for the selected operand.
 391          *            The pointer returned is never NULL.
 392          */
 393         const arch_register_req_t *(*get_irn_reg_req_in)(const ir_node *irn,
 394                                                          int pos);
 395
 396         /**
 397          * Classify the node.
 398          * @param irn The node.
 399          * @return A classification.
 400          */
 401         arch_irn_class_t (*classify)(const ir_node *irn);
 402
 403         /**
 404          * Get the entity on the stack frame this node depends on.
 405          * @param irn  The node in question.
 406          * @return The entity on the stack frame or NULL, if the node does not have
 407          *         a stack frame entity.
 408          */
 409         ir_entity *(*get_frame_entity)(const ir_node *irn);
 410
 411         /**
 412          * Set the offset of a node carrying an entity on the stack frame.
 413          * @param irn  The node.
 414          * @param offset The offset of the node's stack frame entity.
 415          */
 416         void (*set_frame_offset)(ir_node *irn, int offset);
 417
 418         /**
 419          * Returns the delta of the stackpointer for nodes that increment or
 420          * decrement the stackpointer with a constant value. (push, pop
 421          * nodes on most architectures).
 422          * A positive value stands for an expanding stack area, a negative value for
 423          * a shrinking one.
 424          *
 425          * @param irn       The node
 426          * @return          0 if the stackpointer is not modified with a constant
 427          *                  value, otherwise the increment/decrement value
 428          */
 429         int (*get_sp_bias)(const ir_node *irn);
 430
 431         /**
 432          * Returns an inverse operation which yields the i-th argument
 433          * of the given node as result.
 434          *
 435          * @param irn       The original operation
 436          * @param i         Index of the argument we want the inverse operation to
 437          *                  yield
 438          * @param inverse   struct to be filled with the resulting inverse op
 439          * @param obstack   The obstack to use for allocation of the returned nodes
 440          *                  array
 441          * @return          The inverse operation or NULL if operation invertible
 442          */
 443         arch_inverse_t *(*get_inverse)(const ir_node *irn, int i,
 444                                        arch_inverse_t *inverse,
 445                                        struct obstack *obstack);
 446
 447         /**
 448          * Get the estimated cycle count for @p irn.
 449          *
 450          * @param irn  The node.
 451          * @return     The estimated cycle count for this operation
 452          */
 453         int (*get_op_estimated_cost)(const ir_node *irn);
 454
 455         /**
 456          * Asks the backend whether operand @p i of @p irn can be loaded form memory
 457          * internally
 458          *
 459          * @param irn  The node.
 460          * @param i    Index of the argument we would like to know whether @p irn
 461          *             can load it form memory internally
 462          * @return     nonzero if argument can be loaded or zero otherwise
 463          */
 464         int (*possible_memory_operand)(const ir_node *irn, unsigned int i);
 465
 466         /**
 467          * Ask the backend to assimilate @p reload of operand @p i into @p irn.
 468          *
 469          * @param irn    The node.
 470          * @param spill  The spill.
 471          * @param i      The position of the reload.
 472          */
 473         void (*perform_memory_operand)(ir_node *irn, ir_node *spill,
 474                                        unsigned int i);
 475 };
 476
 477 /**
 478  * The code generator interface.
 479  */
 480 struct arch_code_generator_if_t {
 481         /**
 482          * Initialize the code generator.
 483          * @param irg  A graph
 484          * @return     A newly created code generator.
 485          */
 486         void *(*init)(ir_graph *irg);
 487
 488         /**
 489          * return node used as base in pic code addresses
 490          */
 491         ir_node* (*get_pic_base)(void *self);
 492
 493         /**
 494          * Called before abi introduce.
 495          */
 496         void (*before_abi)(void *self);
 497
 498         /**
 499          * Called, when the graph is being normalized.
 500          */
 501         void (*prepare_graph)(void *self);
 502
 503         /**
 504          * Backend may provide an own spiller.
 505          * This spiller needs to spill all register classes.
 506          */
 507         void (*spill)(void *self, ir_graph *irg);
 508
 509         /**
 510          * Called before register allocation.
 511          */
 512         void (*before_ra)(void *self);
 513
 514         /**
 515          * Called after register allocation.
 516          */
 517         void (*after_ra)(void *self);
 518
 519         /**
 520          * Called directly before done is called. This should be the last place
 521          * where the irg is modified.
 522          */
 523         void (*finish)(void *self);
 524
 525         /**
 526          * Called after everything happened. This call should emit the final
 527          * assembly code but avoid changing the irg.
 528          * The code generator must also be de-allocated here.
 529          */
 530         void (*done)(void *self);
 531 };
 532
 533 /**
 534  * helper macro: call function func from the code generator
 535  * if it's implemented.
 536  */
 537 #define _arch_cg_call(cg, func) \
 538 do { \
 539         if((cg)->impl->func) \
 540                 (cg)->impl->func(cg); \
 541 } while(0)
 542
 543 #define _arch_cg_call_env(cg, env, func) \
 544 do { \
 545         if((cg)->impl->func) \
 546                 (cg)->impl->func(cg, env); \
 547 } while(0)
 548
 549 #define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 550 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 551 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 552 #define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 553 #define arch_code_generator_finish(cg)          _arch_cg_call(cg, finish)
 554 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 555 #define arch_code_generator_spill(cg, irg)      _arch_cg_call_env(cg, irg, spill)
 556 #define arch_code_generator_has_spiller(cg)     ((cg)->impl->spill != NULL)
 557 #define arch_code_generator_get_pic_base(cg)    \
 558         ((cg)->impl->get_pic_base != NULL ? (cg)->impl->get_pic_base(cg) : NULL)
 559
 560 /**
 561  * Code generator base class.
 562  */
 563 struct arch_code_generator_t {
 564         const arch_code_generator_if_t *impl;
 565 };
 566
 567 /**
 568  * Architecture interface.
 569  */
 570 struct arch_isa_if_t {
 571         /**
 572          * Initialize the isa interface.
 573          * @param file_handle  the file handle to write the output to
 574          * @return a new isa instance
 575          */
 576         arch_env_t *(*init)(FILE *file_handle);
 577
 578         /**
 579          * Free the isa instance.
 580          */
 581         void (*done)(void *self);
 582
 583         /**
 584          * Called directly after initialization. Backend should handle all
 585          * intrinsics here.
 586          */
 587         void (*handle_intrinsics)(void);
 588
 589         /**
 590          * Get the the number of register classes in the isa.
 591          * @return The number of register classes.
 592          */
 593         unsigned (*get_n_reg_class)(void);
 594
 595         /**
 596          * Get the i-th register class.
 597          * @param i The number of the register class.
 598          * @return The register class.
 599          */
 600         const arch_register_class_t *(*get_reg_class)(unsigned i);
 601
 602         /**
 603          * Get the register class which shall be used to store a value of a given
 604          * mode.
 605          * @param self The this pointer.
 606          * @param mode The mode in question.
 607          * @return A register class which can hold values of the given mode.
 608          */
 609         const arch_register_class_t *(*get_reg_class_for_mode)(const ir_mode *mode);
 610
 611         /**
 612          * Get the ABI restrictions for procedure calls.
 613          * @param self        The this pointer.
 614          * @param call_type   The call type of the method (procedure) in question.
 615          * @param p           The array of parameter locations to be filled.
 616          */
 617         void (*get_call_abi)(const void *self, ir_type *call_type,
 618                              be_abi_call_t *abi);
 619
 620         /**
 621          * Get the code generator interface.
 622          * @param self The this pointer.
 623          * @return     Some code generator interface.
 624          */
 625         const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 626
 627         /**
 628          * Get the list scheduler to use. There is already a selector given, the
 629          * backend is free to modify and/or ignore it.
 630          *
 631          * @param self     The isa object.
 632          * @param selector The selector given by options.
 633          * @return         The list scheduler selector.
 634          */
 635         const list_sched_selector_t *(*get_list_sched_selector)(const void *self,
 636                         list_sched_selector_t *selector);
 637
 638         /**
 639          * Get the ILP scheduler to use.
 640          * @param self  The isa object.
 641          * @return      The ILP scheduler selector
 642          */
 643         const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
 644
 645         /**
 646          * Get the necessary alignment for storing a register of given class.
 647          * @param self  The isa object.
 648          * @param cls   The register class.
 649          * @return      The alignment in bytes.
 650          */
 651         int (*get_reg_class_alignment)(const arch_register_class_t *cls);
 652
 653         /**
 654          * A "static" function, returns the frontend settings
 655          * needed for this backend.
 656          */
 657         const backend_params *(*get_params)(void);
 658
 659         /**
 660          * Returns an 2-dim array of execution units, @p irn can be executed on.
 661          * The first dimension is the type, the second the allowed units of this
 662          * type.
 663          * Each dimension is a NULL terminated list.
 664          * @param self  The isa object.
 665          * @param irn   The node.
 666          * @return An array of allowed execution units.
 667          *         exec_unit = {
 668          *                       { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
 669          *                       ...,
 670          *                       { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
 671          *                       NULL
 672          *                     };
 673          */
 674         const be_execution_unit_t ***(*get_allowed_execution_units)(
 675                         const ir_node *irn);
 676
 677         /**
 678          * Return the abstract machine for this isa.
 679          * @param self  The isa object.
 680          */
 681         const be_machine_t *(*get_machine)(const void *self);
 682
 683         /**
 684          * Return an ordered list of irgs where code should be generated for.
 685          * If NULL is returned, all irg will be taken into account and they will be
 686          * generated in an arbitrary order.
 687          * @param self   The isa object.
 688          * @param irgs   A flexible array ARR_F of length 0 where the backend can
 689          *               append the desired irgs.
 690          * @return A flexible array ARR_F containing all desired irgs in the
 691          *         desired order.
 692          */
 693         ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
 694
 695         /**
 696          * mark node as rematerialized
 697          */
 698         void (*mark_remat)(ir_node *node);
 699
 700         /**
 701          * parse an assembler constraint part and set flags according to its nature
 702          * advances the *c pointer to point to the last parsed character (so if you
 703          * parse a single character don't advance c)
 704          */
 705         asm_constraint_flags_t (*parse_asm_constraint)(const char **c);
 706
 707         /**
 708          * returns true if the string is a valid clobbered (register) in this
 709          * backend
 710          */
 711         int (*is_valid_clobber)(const char *clobber);
 712 };
 713
 714 #define arch_env_done(env)                             ((env)->impl->done(env))
 715 #define arch_env_handle_intrinsics(env)                \
 716         do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
 717 #define arch_env_get_n_reg_class(env)                  ((env)->impl->get_n_reg_class())
 718 #define arch_env_get_reg_class(env,i)                  ((env)->impl->get_reg_class(i))
 719 #define arch_env_get_reg_class_for_mode(env,mode)      ((env)->impl->get_reg_class_for_mode((mode)))
 720 #define arch_env_get_call_abi(env,tp,abi)              ((env)->impl->get_call_abi((env), (tp), (abi)))
 721 #define arch_env_get_code_generator_if(env)            ((env)->impl->get_code_generator_if((env)))
 722 #define arch_env_get_list_sched_selector(env,selector) ((env)->impl->get_list_sched_selector((env), (selector)))
 723 #define arch_env_get_ilp_sched_selector(env)           ((env)->impl->get_ilp_sched_selector(env))
 724 #define arch_env_get_reg_class_alignment(env,cls)      ((env)->impl->get_reg_class_alignment((cls)))
 725 #define arch_env_get_params(env)                       ((env)->impl->get_params())
 726 #define arch_env_get_allowed_execution_units(env,irn)  ((env)->impl->get_allowed_execution_units((irn)))
 727 #define arch_env_get_machine(env)                      ((env)->impl->get_machine(env))
 728 #define arch_env_get_backend_irg_list(env,irgs)        ((env)->impl->get_backend_irg_list((env), (irgs)))
 729 #define arch_env_parse_asm_constraint(env,c)           ((env)->impl->parse_asm_constraint((c))
 730 #define arch_env_is_valid_clobber(env,clobber)         ((env)->impl->is_valid_clobber((clobber))
 731 #define arch_env_mark_remat(env,node) \
 732         do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((node)); } while(0)
 733
 734 /**
 735  * ISA base class.
 736  */
 737 struct arch_env_t {
 738         const arch_isa_if_t   *impl;
 739         const arch_register_t *sp;               /**< The stack pointer register. */
 740         const arch_register_t *bp;               /**< The base pointer register. */
 741         const arch_register_class_t *link_class; /**< The static link pointer
 742                                                       register class. */
 743         int                    stack_dir;        /**< -1 for decreasing, 1 for
 744                                                       increasing. */
 745         int                    stack_alignment;  /**< power of 2 stack alignment */
 746         const be_main_env_t   *main_env;         /**< the be main environment */
 747         int                    spill_cost;       /**< cost for a be_Spill node */
 748         int                    reload_cost;      /**< cost for a be_Reload node */
 749         bool                   custom_abi : 1;   /**< backend does all abi handling
 750                                                       and does not need the generic stuff
 751                                                       from beabi.h/.c */
 752 };
 753
 754 static inline unsigned arch_irn_get_n_outs(const ir_node *node)
 755 {
 756         backend_info_t *info = be_get_info(node);
 757         if (info->out_infos == NULL)
 758                 return 0;
 759
 760         return ARR_LEN(info->out_infos);
 761 }
 762
 763 static inline const arch_irn_ops_t *get_irn_ops_simple(const ir_node *node)
 764 {
 765         const ir_op          *ops    = get_irn_op(node);
 766         const arch_irn_ops_t *be_ops = get_op_ops(ops)->be_ops;
 767         assert(!is_Proj(node));
 768         return be_ops;
 769 }
 770
 771 static inline const arch_register_req_t *arch_get_register_req_out(
 772                 const ir_node *irn)
 773 {
 774         int             pos = 0;
 775         backend_info_t *info;
 776
 777         /* you have to query the Proj nodes for the constraints (or use
 778          * arch_get_out_register_req. Querying a mode_T node and expecting
 779          * arch_no_register_req is a bug in your code! */
 780         assert(get_irn_mode(irn) != mode_T);
 781
 782         if (is_Proj(irn)) {
 783                 pos = get_Proj_proj(irn);
 784                 irn = get_Proj_pred(irn);
 785         }
 786
 787         info = be_get_info(irn);
 788         if (info->out_infos == NULL)
 789                 return arch_no_register_req;
 790
 791         return info->out_infos[pos].req;
 792 }
 793
 794 static inline bool arch_irn_is_ignore(const ir_node *irn)
 795 {
 796         const arch_register_req_t *req = arch_get_register_req_out(irn);
 797         return !!(req->type & arch_register_req_type_ignore);
 798 }
 799
 800 static inline bool arch_irn_consider_in_reg_alloc(
 801                 const arch_register_class_t *cls, const ir_node *node)
 802 {
 803         const arch_register_req_t *req = arch_get_register_req_out(node);
 804         return
 805                 req->cls == cls &&
 806                 !(req->type & arch_register_req_type_ignore);
 807 }
 808
 809 /**
 810  * Get register constraints for an operand at position @p
 811  */
 812 static inline const arch_register_req_t *arch_get_in_register_req(
 813                 const ir_node *node, int pos)
 814 {
 815         const arch_irn_ops_t *ops = get_irn_ops_simple(node);
 816         return ops->get_irn_reg_req_in(node, pos);
 817 }
 818
 819 /**
 820  * Get register constraint for a produced result (the @p pos result)
 821  */
 822 static inline const arch_register_req_t *arch_get_out_register_req(
 823                 const ir_node *node, int pos)
 824 {
 825         const backend_info_t *info = be_get_info(node);
 826         if (info->out_infos == NULL)
 827                 return arch_no_register_req;
 828         return info->out_infos[pos].req;
 829 }
 830
 831 static inline void arch_set_out_register_req(ir_node *node, int pos,
 832                 const arch_register_req_t *req)
 833 {
 834         backend_info_t *info = be_get_info(node);
 835         assert(pos < (int) arch_irn_get_n_outs(node));
 836         info->out_infos[pos].req = req;
 837 }
 838
 839 /**
 840  * Iterate over all values defined by an instruction.
 841  * Only looks at values in a certain register class where the requirements
 842  * are not marked as ignore.
 843  * Executes @p code for each definition.
 844  */
 845 #define be_foreach_definition(node, cls, value, code)                      \
 846         do {                                                                   \
 847         if (get_irn_mode(node) == mode_T) {                                    \
 848                 const ir_edge_t *edge_;                                            \
 849                 foreach_out_edge(node, edge_) {                                    \
 850                         const arch_register_req_t *req_;                               \
 851                         value = get_edge_src_irn(edge_);                               \
 852                         req_  = arch_get_register_req_out(value);                      \
 853                         if (req_->cls != cls)                                          \
 854                                 continue;                                                  \
 855                         if (req_->type & arch_register_req_type_ignore)                \
 856                                 continue;                                                  \
 857                         code                                                           \
 858                 }                                                                  \
 859         } else {                                                               \
 860                 const arch_register_req_t *req_ = arch_get_register_req_out(node); \
 861                 value = node;                                                      \
 862                 if (req_->cls == cls                                               \
 863                                 && !(req_->type & arch_register_req_type_ignore)) {        \
 864                         code                                                           \
 865                 }                                                                  \
 866         }                                                                      \
 867         } while (0)
 868
 869 #endif