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