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