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