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

   1 #ifndef _FIRM_BEARCH_H
   2 #define _FIRM_BEARCH_H
   3
   4 #include "firm_config.h"
   5
   6 #ifdef WITH_LIBCORE
   7 #include <libcore/lc_opts.h>
   8 #endif
   9
  10 #include "firm_types.h"
  11
  12 #include "bitset.h"
  13
  14 #include "belistsched.h"
  15 #include "beabi_t.h"
  16 #include "bearch_t.h"
  17 #include "be_t.h"
  18
  19 struct _be_node_factory_t;
  20
  21 typedef enum _arch_register_type_t {
  22   arch_register_type_none         = 0,
  23   arch_register_type_caller_save  = 1, /**< The register must be saved by the caller
  24                                             upon a function call. It thus can be overwritten
  25                                             in the called function. */
  26   arch_register_type_callee_save  = 2, /**< The register must be saved by the caller
  27                                             upon a function call. It thus can be overwritten
  28                                             in the called function. */
  29   arch_register_type_ignore       = 4, /**< Do not consider this register when allocating. */
  30 } arch_register_type_t;
  31
  32 /**
  33  * Convenience macro to check for register type.
  34  * @param req   A pointer to register.
  35  * @param kind  The kind of type to check for (see arch_register_type_t).
  36  * @return      1, If register is of given kind, 0 if not.
  37  */
  38 #define arch_register_type_is(reg, kind) \
  39   (((reg)->type & arch_register_type_ ## kind) != 0)
  40
  41 /**
  42  * A register.
  43  */
  44 struct _arch_register_t {
  45   const char *name;                         /**< The name of the register. */
  46   const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  47   int index;                                /**< The index of the register in the class. */
  48   arch_register_type_t type;                /**< The type of the register. */
  49   void *data;                               /**< Custom data. */
  50 };
  51
  52 static INLINE const arch_register_class_t *
  53 _arch_register_get_class(const arch_register_t *reg)
  54 {
  55   return reg->reg_class;
  56 }
  57
  58 static INLINE int _arch_register_get_index(const arch_register_t *reg)
  59 {
  60   return reg->index;
  61 }
  62
  63 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  64 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  65 #define arch_register_get_name(reg)       ((reg)->name)
  66
  67 /**
  68  * A class of registers.
  69  * Like general purpose or floating point.
  70  */
  71 struct _arch_register_class_t {
  72   const char *name;               /**< The name of the register class. */
  73   int n_regs;                     /**< Number of registers in this class. */
  74   ir_mode *mode;                  /**< The mode of the register class. */
  75   const arch_register_t *regs;    /**< The array of registers. */
  76 };
  77
  78 /** return the number of registers in this register class */
  79 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  80
  81 /** return the largest mode of this register class */
  82 #define arch_register_class_mode(cls) ((cls)->mode)
  83
  84 /**
  85  * Put all registers in a class into a bitset.
  86  * @param cls The class.
  87  * @param bs The bitset. May be NULL.
  88  * @return The number of registers in the class.
  89  */
  90 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
  91
  92 static INLINE const arch_register_t *
  93 _arch_register_for_index(const arch_register_class_t *cls, int idx)
  94 {
  95   assert(0 <= idx && idx < cls->n_regs);
  96   return &cls->regs[idx];
  97 }
  98
  99 #define arch_register_for_index(cls, idx) \
 100   _arch_register_for_index(cls, idx)
 101
 102 typedef enum _arch_operand_type_t {
 103   arch_operand_type_invalid,
 104   arch_operand_type_memory,
 105   arch_operand_type_register,
 106   arch_operand_type_immediate,
 107   arch_operand_type_symconst,
 108   arch_operand_type_last
 109 } arch_operand_type_t;
 110
 111 /**
 112  * Different types of register allocation requirements.
 113  */
 114 typedef enum _arch_register_req_type_t {
 115   arch_register_req_type_none = 0,        /**< No register requirement. */
 116
 117   arch_register_req_type_normal = 1,      /**< All registers in the class
 118                                                are allowed. */
 119
 120   arch_register_req_type_limited = 2,     /**< Only a real subset of
 121                                                the class is allowed. */
 122
 123   arch_register_req_type_should_be_same = 4,       /**< The register should be equal
 124                                                         another one at the node. */
 125
 126   arch_register_req_type_should_be_different = 8,  /**< The register must be unequal
 127                                                         to some other at the node. */
 128
 129   arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
 130                                                         all in's at the node */
 131 } arch_register_req_type_t;
 132
 133 /**
 134  * Convenience macro to check for set constraints.
 135  * @param req   A pointer to register requirements.
 136  * @param kind  The kind of constraint to check for (see arch_register_req_type_t).
 137  * @return      1, If the kind of constraint is present, 0 if not.
 138  */
 139 #define arch_register_req_is(req, kind) \
 140         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 141
 142 /**
 143  * Expresses requirements to register allocation for an operand.
 144  */
 145 typedef struct _arch_register_req_t {
 146         arch_register_req_type_t type;          /**< The type of the constraint. */
 147         const arch_register_class_t *cls;       /**< The register class this constraint belongs to. */
 148
 149         void (*limited)(void *limited_env, bitset_t *bs);
 150                                           /**< In case of the 'limited'
 151                                             constraint, this function
 152                                             must put all allowable
 153                                             registers in the bitset and
 154                                             return the number of registers
 155                                             in the bitset. */
 156
 157         void *limited_env;                    /**< This must passed to limited. */
 158
 159         ir_node *other_same;                      /**< The other which shall have the same reg
 160                                                                                     as this one. (for case should_be_same). */
 161
 162         ir_node *other_different;             /**< The other node from which this one's register
 163                                                                                     must be different (case must_be_different). */
 164 } arch_register_req_t;
 165
 166 /**
 167  * Format a register requirements information into a string.
 168  * @param buf The string where to put it to.
 169  * @param len The size of @p buf.
 170  * @param req The requirements structure to format.
 171  * @return    A pointer to buf.
 172  */
 173 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
 174
 175
 176 /**
 177  * Certain node classes which are relevant for the register allocator.
 178  */
 179 typedef enum _arch_irn_class_t {
 180   arch_irn_class_normal,
 181   arch_irn_class_spill,
 182   arch_irn_class_reload,
 183   arch_irn_class_copy,
 184   arch_irn_class_perm,
 185   arch_irn_class_branch,
 186   arch_irn_class_call,
 187   arch_irn_class_const,
 188 } arch_irn_class_t;
 189
 190 /**
 191  * An inverse operation returned by the backend
 192  */
 193 typedef struct _arch_inverse_t {
 194         int      n;       /**< count of nodes returned in nodes array */
 195         int      costs;   /**< costs of this remat */
 196
 197         /**< nodes for this inverse operation. shall be in
 198          *  schedule order. last element is the target value
 199          */
 200         ir_node  **nodes;
 201 } arch_inverse_t;
 202
 203 /**
 204  * Some flags describing a node in more detail.
 205  */
 206 typedef enum _arch_irn_flags_t {
 207         arch_irn_flags_none             = 0, /**< Node flags. */
 208         arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
 209         arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
 210         arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
 211         arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
 212         arch_irn_flags_last             = arch_irn_flags_modify_sp
 213 } arch_irn_flags_t;
 214
 215 /**
 216  * Get the string representation of a flag.
 217  * This functions does not handle or'ed bitmasks of flags.
 218  * @param flag The flag.
 219  * @return The flag as a string.
 220  */
 221 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
 222
 223 struct _arch_irn_ops_if_t {
 224
 225   /**
 226    * Get the register requirements for a given operand.
 227    * @param self The self pointer.
 228    * @param irn The node.
 229    * @param pos The operand's position
 230          *                                              (-1 for the result of the node, 0..n for the input
 231          *                                              operands).
 232    * @return    The register requirements for the selected operand.
 233    *            The pointer returned is never NULL.
 234    */
 235   const arch_register_req_t *(*get_irn_reg_req)(const void *self,
 236       arch_register_req_t *req, const ir_node *irn, int pos);
 237
 238   /**
 239    * Set the register for an output operand.
 240    * @param irn The node.
 241    * @param reg The register allocated to that operand.
 242    * @note      If the operand is not a register operand,
 243    *            the call is ignored.
 244    */
 245   void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 246
 247   /**
 248    * Get the register allocated for an output operand.
 249    * @param irn The node.
 250    * @return    The register allocated at that operand. NULL, if
 251    *            the operand was no register operand or
 252    *            @c arch_register_invalid, if no register has yet been
 253    *            allocated for this node.
 254    */
 255   const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 256
 257   /**
 258    * Classify the node.
 259    * @param irn The node.
 260    * @return A classification.
 261    */
 262   arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 263
 264   /**
 265    * Get the flags of a node.
 266    * @param self The irn ops themselves.
 267    * @param irn The node.
 268    * @return A set of flags.
 269    */
 270   arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 271
 272   /**
 273    * Get the entity on the stack frame this node depends on.
 274    * @param self The this pointer.
 275    * @param irn  The node in question.
 276    * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
 277    */
 278   entity *(*get_frame_entity)(const void *self, const ir_node *irn);
 279
 280   /**
 281    * Set the offset of a node carrying an entity on the stack frame.
 282    * @param self The this pointer.
 283    * @param irn  The node.
 284    * @param offset The offset of the node's stack frame entity.
 285    */
 286   void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
 287
 288   /**
 289    * Returns an inverse operation which yields the i-th argument
 290    * of the given node as result.
 291    *
 292    * @param irn       The original operation
 293    * @param i         Index of the argument we want the inverse operation to yield
 294    * @param inverse   struct to be filled with the resulting inverse op
 295    * @param obstack   The obstack to use for allocation of the returned nodes array
 296    * @return          The inverse operation or NULL if operation invertible
 297    */
 298   arch_inverse_t *(*get_inverse)(const void *self, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
 299
 300 };
 301
 302 /**
 303  * irn_ops base class.
 304  */
 305 struct _arch_irn_ops_t {
 306         const arch_irn_ops_if_t *impl;
 307 };
 308
 309 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
 310
 311 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
 312
 313 extern arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack);
 314
 315 /**
 316  * Get the register requirements for a node.
 317  * @param env The architecture environment.
 318  * @param req A pointer to a requirements structure, where the data can
 319  *            be put into.
 320  * @param irn The node.
 321  * @param pos The position of the operand you're interested in.
 322  * @return    A pointer to the register requirements which may <b>not</b>
 323  *            neccessarily be equal to @p req. If NULL is returned, the
 324  *            operand was no register operand.
 325  */
 326 extern const arch_register_req_t *
 327 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 328     const ir_node *irn, int pos);
 329
 330 /**
 331  * Check if an operand is a register operand.
 332  * @param env The environment.
 333  * @param irn The node.
 334  * @param pos The position of the operand.
 335  * @return 1, if the operand is significant for register allocation, 0
 336  * if not.
 337  */
 338 extern int arch_is_register_operand(const arch_env_t *env,
 339     const ir_node *irn, int pos);
 340
 341 /**
 342  * Get the number of allocatable registers concerning
 343  * a register class for an operand of a node.
 344  * @param env The environment.
 345  * @param irn The node.
 346  * @param pos The postition of the node's operand.
 347  * @param bs  The bitset all allocatable registers shall be put into.
 348  *            Note, that you can also pass NULL here. If you don't,
 349  *            make sure, the bitset is as large as the register class
 350  *            has registers.
 351  * @return    The amount of registers allocatable for that operand.
 352  */
 353 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
 354
 355 /**
 356  * Put all registers which shall not be ignored by the register
 357  * allocator in a bit set.
 358  * @param env The arch env.
 359  * @param cls The register class to consider.
 360  * @param bs  The bit set to put the registers to.
 361  */
 362 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
 363
 364 /**
 365  * Check, if a register is assignable to an operand of a node.
 366  * @param env The architecture environment.
 367  * @param irn The node.
 368  * @param pos The position of the operand.
 369  * @param reg The register.
 370  * @return    1, if the register might be allocated to the operand 0 if not.
 371  */
 372 extern int arch_reg_is_allocatable(const arch_env_t *env,
 373     const ir_node *irn, int pos, const arch_register_t *reg);
 374
 375 /**
 376  * Get the register class of an operand of a node.
 377  * @param env The architecture environment.
 378  * @param irn The node.
 379  * @param pos The position of the operand, -1 for the output.
 380  * @return    The register class of the operand or NULL, if
 381  *            operand is a non-register operand.
 382  */
 383 extern const arch_register_class_t *
 384 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 385
 386 /**
 387  * Get the register allocated at a certain output operand of a node.
 388  * @param env The arch environment.
 389  * @param irn The node.
 390  * @return    The register allocated for this operand
 391  */
 392 extern const arch_register_t *
 393 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 394
 395 /**
 396  * Set the register for a certain output operand.
 397  * @param env The architecture environment.
 398  * @param irn The node.
 399  * @param idx The index of the output operand.
 400  * @param reg The register.
 401  */
 402 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 403                 const arch_register_t *reg);
 404
 405 /**
 406  * Classify a node.
 407  * @param env The architecture environment.
 408  * @param irn The node.
 409  * @return A classification of the node.
 410  */
 411 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 412
 413 /**
 414  * Get the flags of a node.
 415  * @param env The architecture environment.
 416  * @param irn The node.
 417  * @return The flags.
 418  */
 419 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 420
 421 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
 422
 423 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 424   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 425
 426 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
 427         (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
 428
 429 /**
 430  * Somebody who can be asked about IR nodes.
 431  */
 432 struct _arch_irn_handler_t {
 433
 434   /**
 435     * Get the operations of an irn.
 436     * @param self The handler from which the method is invoked.
 437     * @param irn Some node.
 438     * @return Operations for that irn.
 439     */
 440   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
 441       const ir_node *irn);
 442 };
 443
 444 /**
 445  * The code generator interface.
 446  */
 447 struct _arch_code_generator_if_t {
 448         /**
 449          * Initialize the code generator.
 450          * @param birg A backend IRG session.
 451          * @return     A newly created code generator.
 452          */
 453         void *(*init)(const be_irg_t *birg);
 454
 455         /**
 456          * Called before abi introduce.
 457          */
 458         void (*before_abi)(void *self);
 459
 460         /**
 461          * Called, when the graph is being normalized.
 462          */
 463         void (*prepare_graph)(void *self);
 464
 465         /**
 466          * Called before scheduling.
 467          */
 468         void (*before_sched)(void *self);
 469
 470         /**
 471          * Called before register allocation.
 472          */
 473         void (*before_ra)(void *self);
 474
 475         /**
 476          * Called after register allocation.
 477          */
 478         void (*after_ra)(void *self);
 479
 480         /**
 481          * Called after everything happened.
 482          * The code generator must also be de-allocated here.
 483          */
 484         void (*done)(void *self);
 485 };
 486
 487 /**
 488  * helper macro: call function func from the code generator
 489  * if it's implemented.
 490  */
 491 #define _arch_cg_call(cg, func) \
 492 do { \
 493         if((cg)->impl->func) \
 494                 (cg)->impl->func(cg); \
 495 } while(0)
 496
 497 #define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 498 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 499 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 500 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 501 #define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 502 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 503
 504 /**
 505  * Code generator base class.
 506  */
 507 struct _arch_code_generator_t {
 508         const arch_code_generator_if_t *impl;
 509 };
 510
 511 /**
 512  * ISA base class.
 513  */
 514 struct _arch_isa_t {
 515         const arch_isa_if_t *impl;
 516         const arch_register_t *sp;  /** The stack pointer register. */
 517         const arch_register_t *bp;  /** The base pointer register. */
 518         const int stack_dir;        /** -1 for decreasing, 1 for increasing. */
 519 };
 520
 521 #define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
 522 #define arch_isa_sp(isa)         ((isa)->sp)
 523 #define arch_isa_bp(isa)         ((isa)->bp)
 524
 525 /**
 526  * Architecture interface.
 527  */
 528 struct _arch_isa_if_t {
 529
 530   /**
 531    * Initialize the isa interface.
 532          * @param file_handle  the file handle to write the output to
 533          * @return a new isa instance
 534    */
 535   void *(*init)(FILE *file_handle);
 536
 537   /**
 538    * Free the isa instance.
 539    */
 540   void (*done)(void *self);
 541
 542   /**
 543    * Get the the number of register classes in the isa.
 544    * @return The number of register classes.
 545    */
 546   int (*get_n_reg_class)(const void *self);
 547
 548   /**
 549    * Get the i-th register class.
 550    * @param i The number of the register class.
 551    * @return The register class.
 552    */
 553   const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 554
 555   /**
 556    * Get the register class which shall be used to store a value of a given mode.
 557    * @param self The this pointer.
 558    * @param mode The mode in question.
 559    * @return A register class which can hold values of the given mode.
 560    */
 561   const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
 562
 563   /**
 564    * Get the ABI restrictions for procedure calls.
 565    * @param self        The this pointer.
 566    * @param method_type The type of the method (procedure) in question.
 567    * @param p           The array of parameter locations to be filled.
 568    */
 569   void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
 570
 571   /**
 572    * The irn handler for this architecture.
 573    * The irn handler is registered by the Firm back end
 574    * when the architecture is initialized.
 575    * (May be NULL).
 576    */
 577   const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 578
 579   /**
 580    * Get the code generator interface.
 581    * @param self The this pointer.
 582    * @return     Some code generator interface.
 583    */
 584   const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 585
 586   /**
 587    * Get the list scheduler to use.
 588    * @param self  The isa object.
 589    * @return      The list scheduler selector.
 590    */
 591   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
 592
 593   /**
 594    * Get the necessary alignment for storing a register of given class.
 595    * @param self  The isa object.
 596    * @param cls   The register class.
 597    * @return      The alignment in bytes.
 598    */
 599   int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
 600
 601 #ifdef WITH_LIBCORE
 602         /**
 603          * Register command line options for this backend.
 604          * @param grp  The root group.
 605          */
 606   void (*register_options)(lc_opt_entry_t *grp);
 607 #endif
 608 };
 609
 610 #define arch_isa_get_n_reg_class(isa)                ((isa)->impl->get_n_reg_class(isa))
 611 #define arch_isa_get_reg_class(isa,i)                ((isa)->impl->get_reg_class(isa, i))
 612 #define arch_isa_get_irn_handler(isa)                ((isa)->impl->get_irn_handler(isa))
 613 #define arch_isa_get_call_abi(isa,tp,abi)            ((isa)->impl->get_call_abi((isa), (tp), (abi)))
 614 #define arch_isa_get_reg_class_for_mode(isa,mode)    ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
 615 #define arch_isa_make_code_generator(isa,irg)        ((isa)->impl->make_code_generator((isa), (irg)))
 616 #define arch_isa_get_reg_class_alignment(isa, cls)   ((isa)->impl->get_reg_class_alignment((isa), (cls)))
 617
 618 #define ARCH_MAX_HANDLERS         8
 619
 620 /**
 621  * Environment for the architecture infrastructure.
 622  * Keep this everywhere you're going.
 623  */
 624 struct _arch_env_t {
 625   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 626   arch_isa_t *isa;                                /**< The isa about which everything is. */
 627
 628   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 629                                                            a stack. */
 630
 631   int handlers_tos;                                   /**< The stack pointer of the handler
 632                                                         stack. */
 633 };
 634
 635 /**
 636  * Get the isa of an arch environment.
 637  * @param env The environment.
 638  * @return The isa with which the env was initialized with.
 639  */
 640 #define arch_env_get_isa(env)   ((env)->isa)
 641
 642 /**
 643  * Initialize the architecture environment struct.
 644  * @param isa           The isa which shall be put into the environment.
 645  * @param file_handle   The file handle
 646  * @return The environment.
 647  */
 648 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle);
 649
 650 /**
 651  * Add a node handler to the environment.
 652  * @param env The environment.
 653  * @param handler A node handler.
 654  * @return The environment itself.
 655  */
 656 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
 657
 658 /**
 659  * Remove a node handler from the handler stack.
 660  * @param env The architecture environment.
 661  * @return The popped handler.
 662  */
 663 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 664
 665 #endif /* _FIRM_BEARCH_H */