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

   1 /*
   2  * Copyright (C) 1995-2007 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 - internal data structures.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BEARCH_T_H
  27 #define FIRM_BE_BEARCH_T_H
  28
  29 #include "bearch.h"
  30
  31 #include "belistsched.h"
  32 #include "beilpsched.h"
  33 #include "bemachine.h"
  34 #include "beirg.h"
  35 #include "beabi.h"
  36
  37 /**
  38  * A register.
  39  */
  40 struct arch_register_t {
  41         const char                  *name;        /**< The name of the register. */
  42         const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  43         unsigned                    index;        /**< The index of the register in the class. */
  44         arch_register_type_t        type;         /**< The type of the register. */
  45         void                        *data;        /**< Custom data. */
  46 };
  47
  48 static INLINE const arch_register_class_t *
  49 _arch_register_get_class(const arch_register_t *reg)
  50 {
  51         return reg->reg_class;
  52 }
  53
  54 static INLINE
  55 unsigned _arch_register_get_index(const arch_register_t *reg)
  56 {
  57         return reg->index;
  58 }
  59
  60 static INLINE
  61 const char *_arch_register_get_name(const arch_register_t *reg)
  62 {
  63         return reg->name;
  64 }
  65
  66 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  67 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  68 #define arch_register_get_name(reg)       _arch_register_get_name(reg)
  69
  70 /**
  71  * Convenience macro to check for register type.
  72  * @param req   A pointer to register.
  73  * @param kind  The kind of type to check for (see arch_register_type_t).
  74  * @return      1, If register is of given kind, 0 if not.
  75  */
  76 #define arch_register_type_is(reg, kind) \
  77   (((reg)->type & arch_register_type_ ## kind) != 0)
  78
  79 /**
  80  * A class of registers.
  81  * Like general purpose or floating point.
  82  */
  83 struct arch_register_class_t {
  84         unsigned                     index;  /**< index of this register class */
  85         const char                  *name;   /**< The name of the register class.*/
  86         unsigned                     n_regs; /**< Number of registers in this
  87                                                   class. */
  88         ir_mode                     *mode;   /**< The mode of the register class.*/
  89         const arch_register_t       *regs;   /**< The array of registers. */
  90         arch_register_class_flags_t  flags;  /**< register class flags. */
  91 };
  92
  93 /** return the number of registers in this register class */
  94 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  95
  96 /** return the largest mode of this register class */
  97 #define arch_register_class_mode(cls) ((cls)->mode)
  98
  99 /** return the name of this register class */
 100 #define arch_register_class_name(cls) ((cls)->name)
 101
 102 /** return the index of this register class */
 103 #define arch_register_class_index(cls)  ((cls)->index)
 104
 105 /** return the register class flags */
 106 #define arch_register_class_flags(cls) ((cls)->flags)
 107
 108 static INLINE const arch_register_t *
 109 _arch_register_for_index(const arch_register_class_t *cls, unsigned idx)
 110 {
 111         assert(idx < cls->n_regs);
 112         return &cls->regs[idx];
 113 }
 114
 115 #define arch_register_for_index(cls, idx)   _arch_register_for_index(cls, idx)
 116
 117 /**
 118  * Convenience macro to check for set constraints.
 119  * @param req   A pointer to register requirements.
 120  * @param kind  The kind of constraint to check for (see arch_register_req_type_t).
 121  * @return      1, If the kind of constraint is present, 0 if not.
 122  */
 123 #define arch_register_req_is(req, kind) \
 124         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 125
 126 /**
 127  * Expresses requirements to register allocation for an operand.
 128  */
 129 struct arch_register_req_t {
 130         arch_register_req_type_t type;      /**< The type of the constraint. */
 131         const arch_register_class_t *cls;   /**< The register class this constraint belongs to. */
 132
 133         const unsigned *limited;            /**< allowed register bitset */
 134
 135         int other_same[2];                /**< The in numbers which shall have the
 136                                                same res (should_be_same).  More than
 137                                                two are unnecessary because there is
 138                                                no machine with more than two
 139                                                commutative inputs to one operation */
 140         int other_different;                /**< The other node from which this
 141                                                                                      one's register must be different
 142                                                                                          (case must_be_different). */
 143 };
 144
 145 /**
 146  * An inverse operation returned by the backend
 147  */
 148 struct arch_inverse_t {
 149         int      n;       /**< count of nodes returned in nodes array */
 150         int      costs;   /**< costs of this remat */
 151
 152         /**< nodes for this inverse operation. shall be in
 153          *  schedule order. last element is the target value
 154          */
 155         ir_node  **nodes;
 156 };
 157
 158 struct arch_irn_ops_if_t {
 159
 160         /**
 161          * Get the register requirements for a given operand.
 162          * @param self The self pointer.
 163          * @param irn The node.
 164          * @param pos The operand's position
 165          *        (-1 for the result of the node, 0..n for the input operands).
 166          * @return    The register requirements for the selected operand.
 167          *            The pointer returned is never NULL.
 168          */
 169         const arch_register_req_t *(*get_irn_reg_req)(const void *self,
 170                                                       const ir_node *irn, int pos);
 171
 172         /**
 173          * Set the register for an output operand.
 174          * @param irn The node.
 175          * @param reg The register allocated to that operand.
 176          * @note      If the operand is not a register operand,
 177          *            the call is ignored.
 178          */
 179         void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 180
 181         /**
 182          * Get the register allocated for an output operand.
 183          * @param irn The node.
 184          * @return    The register allocated at that operand. NULL, if
 185          *            the operand was no register operand or
 186          *            @c arch_register_invalid, if no register has yet been
 187          *            allocated for this node.
 188          */
 189         const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 190
 191         /**
 192          * Classify the node.
 193          * @param irn The node.
 194          * @return A classification.
 195          */
 196         arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 197
 198         /**
 199          * Get the flags of a node.
 200          * @param self The irn ops themselves.
 201          * @param irn The node.
 202          * @return A set of flags.
 203          */
 204         arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 205
 206         /**
 207          * Get the entity on the stack frame this node depends on.
 208          * @param self The this pointer.
 209          * @param irn  The node in question.
 210          * @return The entity on the stack frame or NULL, if the node does not have a
 211          *         stack frame entity.
 212          */
 213         ir_entity *(*get_frame_entity)(const void *self, const ir_node *irn);
 214
 215         /**
 216          * Set the entity on the stack frame this node depends on.
 217          * @param self The this pointer.
 218          * @param irn  The node in question.
 219          * @param ent  The entity to set
 220          */
 221         void (*set_frame_entity)(const void *self, ir_node *irn, ir_entity *ent);
 222
 223         /**
 224          * Set the offset of a node carrying an entity on the stack frame.
 225          * @param self The this pointer.
 226          * @param irn  The node.
 227          * @param offset The offset of the node's stack frame entity.
 228          */
 229         void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
 230
 231         /**
 232          * Returns the delta of the stackpointer for nodes that increment or
 233          * decrement the stackpointer with a constant value. (push, pop
 234          * nodes on most architectures).
 235          * A positive value stands for an expanding stack area, a negative value for
 236          * a shrinking one.
 237          *
 238          * @param self      The this pointer
 239          * @param irn       The node
 240          * @return          0 if the stackpointer is not modified with a constant
 241          *                  value, otherwise the increment/decrement value
 242          */
 243         int (*get_sp_bias)(const void *self, const ir_node *irn);
 244
 245         /**
 246          * Returns an inverse operation which yields the i-th argument
 247          * of the given node as result.
 248          *
 249          * @param self      The this pointer.
 250          * @param irn       The original operation
 251          * @param i         Index of the argument we want the inverse operation to yield
 252          * @param inverse   struct to be filled with the resulting inverse op
 253          * @param obstack   The obstack to use for allocation of the returned nodes array
 254          * @return          The inverse operation or NULL if operation invertible
 255          */
 256         arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
 257
 258         /**
 259          * Get the estimated cycle count for @p irn.
 260          *
 261          * @param self The this pointer.
 262          * @param irn  The node.
 263          *
 264          * @return     The estimated cycle count for this operation
 265          */
 266         int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
 267
 268         /**
 269          * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
 270          *
 271          * @param self The this pointer.
 272          * @param irn  The node.
 273          * @param i    Index of the argument we would like to know whether @p irn can load it form memory internally
 274          *
 275          * @return     nonzero if argument can be loaded or zero otherwise
 276          */
 277         int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
 278
 279         /**
 280          * Ask the backend to assimilate @p reload of operand @p i into @p irn.
 281          *
 282          * @param self   The this pointer.
 283          * @param irn    The node.
 284          * @param spill  The spill.
 285          * @param i      The position of the reload.
 286          */
 287         void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
 288 };
 289
 290 /**
 291  * irn_ops base class.
 292  */
 293 struct arch_irn_ops_t {
 294         const arch_irn_ops_if_t *impl;
 295 };
 296
 297 /**
 298  * Somebody who can be asked about IR nodes.
 299  */
 300 struct arch_irn_handler_t {
 301
 302   /**
 303     * Get the operations of an irn.
 304     * @param self The handler from which the method is invoked.
 305     * @param irn Some node.
 306     * @return Operations for that irn.
 307     */
 308   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
 309       const ir_node *irn);
 310 };
 311
 312 /**
 313  * The code generator interface.
 314  */
 315 struct arch_code_generator_if_t {
 316         /**
 317          * Initialize the code generator.
 318          * @param birg A backend IRG session.
 319          * @return     A newly created code generator.
 320          */
 321         void *(*init)(be_irg_t *birg);
 322
 323         /**
 324          * Called before abi introduce.
 325          */
 326         void (*before_abi)(void *self);
 327
 328         /**
 329          * Called, when the graph is being normalized.
 330          */
 331         void (*prepare_graph)(void *self);
 332
 333         /**
 334          * Backend may provide an own spiller.
 335          * This spiller needs to spill all register classes.
 336          */
 337         void (*spill)(void *self, be_irg_t *birg);
 338
 339         /**
 340          * Called before scheduling.
 341          */
 342         void (*before_sched)(void *self);
 343
 344         /**
 345          * Called before register allocation.
 346          */
 347         void (*before_ra)(void *self);
 348
 349         /**
 350          * Called after register allocation.
 351          */
 352         void (*after_ra)(void *self);
 353
 354         /**
 355          * Called directly before done is called. This should be the last place
 356          * where the irg is modified.
 357          */
 358         void (*finish)(void *self);
 359
 360         /**
 361          * Called after everything happened. This call should emit the final
 362          * assembly code but avoid changing the irg.
 363          * The code generator must also be de-allocated here.
 364          */
 365         void (*done)(void *self);
 366 };
 367
 368 /**
 369  * helper macro: call function func from the code generator
 370  * if it's implemented.
 371  */
 372 #define _arch_cg_call(cg, func) \
 373 do { \
 374         if((cg)->impl->func) \
 375                 (cg)->impl->func(cg); \
 376 } while(0)
 377
 378 #define _arch_cg_call_env(cg, env, func) \
 379 do { \
 380         if((cg)->impl->func) \
 381                 (cg)->impl->func(cg, env); \
 382 } while(0)
 383
 384 #define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 385 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 386 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 387 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 388 #define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 389 #define arch_code_generator_finish(cg)          _arch_cg_call(cg, finish)
 390 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 391 #define arch_code_generator_spill(cg, birg)     _arch_cg_call_env(cg, birg, spill)
 392 #define arch_code_generator_has_spiller(cg)     ((cg)->impl->spill != NULL)
 393
 394 /**
 395  * Code generator base class.
 396  */
 397 struct arch_code_generator_t {
 398         const arch_code_generator_if_t *impl;
 399 };
 400
 401 /**
 402  * ISA base class.
 403  */
 404 struct arch_isa_t {
 405         const arch_isa_if_t   *impl;
 406         const arch_register_t *sp;        /** The stack pointer register. */
 407         const arch_register_t *bp;        /** The base pointer register. */
 408         const int              stack_dir; /** -1 for decreasing, 1 for increasing. */
 409         const be_main_env_t   *main_env;  /** the be main environment */
 410         const int              spill_cost;  /** cost for a be_Spill node */
 411         const int              reload_cost; /** cost for a be_Reload node */
 412 };
 413
 414 #define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
 415 #define arch_isa_sp(isa)         ((isa)->sp)
 416 #define arch_isa_bp(isa)         ((isa)->bp)
 417
 418 /**
 419  * Architecture interface.
 420  */
 421 struct arch_isa_if_t {
 422         /**
 423          * Initialize the isa interface.
 424          * @param file_handle  the file handle to write the output to
 425          * @param main_env     the be main environment
 426          * @return a new isa instance
 427          */
 428         void *(*init)(FILE *file_handle);
 429
 430         /**
 431          * Free the isa instance.
 432          */
 433         void (*done)(void *self);
 434
 435         /**
 436          * Get the the number of register classes in the isa.
 437          * @return The number of register classes.
 438          */
 439         unsigned (*get_n_reg_class)(const void *self);
 440
 441         /**
 442          * Get the i-th register class.
 443          * @param i The number of the register class.
 444          * @return The register class.
 445          */
 446         const arch_register_class_t *(*get_reg_class)(const void *self, unsigned i);
 447
 448         /**
 449          * Get the register class which shall be used to store a value of a given mode.
 450          * @param self The this pointer.
 451          * @param mode The mode in question.
 452          * @return A register class which can hold values of the given mode.
 453          */
 454         const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
 455
 456         /**
 457          * Get the ABI restrictions for procedure calls.
 458          * @param self        The this pointer.
 459          * @param method_type The type of the method (procedure) in question.
 460          * @param p           The array of parameter locations to be filled.
 461          */
 462         void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
 463
 464         /**
 465          * The irn handler for this architecture.
 466          * The irn handler is registered by the Firm back end
 467          * when the architecture is initialized.
 468          * (May be NULL).
 469          */
 470         const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 471
 472         /**
 473          * Get the code generator interface.
 474          * @param self The this pointer.
 475          * @return     Some code generator interface.
 476          */
 477         const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 478
 479         /**
 480          * Get the list scheduler to use. There is already a selector given, the
 481          * backend is free to modify and/or ignore it.
 482          *
 483          * @param self     The isa object.
 484          * @param selector The selector given by options.
 485          * @return         The list scheduler selector.
 486          */
 487         const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
 488
 489         /**
 490          * Get the ILP scheduler to use.
 491          * @param self  The isa object.
 492          * @return      The ILP scheduler selector
 493          */
 494         const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
 495
 496         /**
 497          * Get the necessary alignment for storing a register of given class.
 498          * @param self  The isa object.
 499          * @param cls   The register class.
 500          * @return      The alignment in bytes.
 501          */
 502         int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
 503
 504         /**
 505          * A "static" function, returns the frontend settings
 506          * needed for this backend.
 507          */
 508         const backend_params *(*get_params)(void);
 509
 510         /**
 511          * Returns an 2-dim array of execution units, @p irn can be executed on.
 512          * The first dimension is the type, the second the allowed units of this
 513          * type.
 514          * Each dimension is a NULL terminated list.
 515          * @param self  The isa object.
 516          * @param irn   The node.
 517          * @return An array of allowed execution units.
 518          *         exec_unit = {
 519          *                       { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
 520          *                       ...,
 521          *                       { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
 522          *                       NULL
 523          *                     };
 524          */
 525         const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
 526
 527         /**
 528          * Return the abstract machine for this isa.
 529          * @param self  The isa object.
 530          */
 531         const be_machine_t *(*get_machine)(const void *self);
 532
 533         /**
 534          * Return an ordered list of irgs where code should be generated for.
 535          * If NULL is returned, all irg will be taken into account and they will be
 536          * generated in an arbitrary order.
 537          * @param self   The isa object.
 538          * @param irgs   A flexible array ARR_F of length 0 where the backend can append the desired irgs.
 539          * @return A flexible array ARR_F containing all desired irgs in the desired order.
 540          */
 541         ir_graph **(*get_backend_irg_list)(const void *self, ir_graph ***irgs);
 542 };
 543
 544 #define arch_isa_get_n_reg_class(isa)                  ((isa)->impl->get_n_reg_class(isa))
 545 #define arch_isa_get_reg_class(isa,i)                  ((isa)->impl->get_reg_class(isa, i))
 546 #define arch_isa_get_irn_handler(isa)                  ((isa)->impl->get_irn_handler(isa))
 547 #define arch_isa_get_call_abi(isa,tp,abi)              ((isa)->impl->get_call_abi((isa), (tp), (abi)))
 548 #define arch_isa_get_reg_class_for_mode(isa,mode)      ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
 549 #define arch_isa_make_code_generator(isa,irg)          ((isa)->impl->make_code_generator((isa), (irg)))
 550 #define arch_isa_get_reg_class_alignment(isa, cls)     ((isa)->impl->get_reg_class_alignment((isa), (cls)))
 551 #define arch_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
 552 #define arch_isa_get_machine(isa)                      ((isa)->impl->get_machine((isa)))
 553 #define arch_isa_get_backend_irg_list(isa, irgs)       ((isa)->impl->get_backend_irg_list((isa), (irgs)))
 554
 555 #define ARCH_MAX_HANDLERS         8
 556
 557 /**
 558  * Environment for the architecture infrastructure.
 559  * Keep this everywhere you're going.
 560  */
 561 struct arch_env_t {
 562         arch_isa_t *isa;                                /**< The isa about which everything is. */
 563
 564         arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 565                                                            a stack. */
 566
 567         int handlers_tos;                                   /**< The stack pointer of the handler
 568                                                         stack. */
 569 };
 570
 571 /**
 572  * Get the isa of an arch environment.
 573  * @param env The environment.
 574  * @return The isa with which the env was initialized with.
 575  */
 576 #define arch_env_get_isa(env)   ((env)->isa)
 577
 578 #endif /* FIRM_BE_BEARCH_T_H */