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