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  * Some flags describing a node in more detail.
 192  */
 193 typedef enum _arch_irn_flags_t {
 194         arch_irn_flags_none             = 0, /**< Node flags. */
 195         arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
 196         arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
 197         arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
 198         arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
 199         arch_irn_flags_last             = arch_irn_flags_modify_sp
 200 } arch_irn_flags_t;
 201
 202 /**
 203  * Get the string representation of a flag.
 204  * This functions does not handle or'ed bitmasks of flags.
 205  * @param flag The flag.
 206  * @return The flag as a string.
 207  */
 208 extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
 209
 210 struct _arch_irn_ops_if_t {
 211
 212   /**
 213    * Get the register requirements for a given operand.
 214    * @param self The self pointer.
 215    * @param irn The node.
 216    * @param pos The operand's position
 217          *                                              (-1 for the result of the node, 0..n for the input
 218          *                                              operands).
 219    * @return    The register requirements for the selected operand.
 220    *            The pointer returned is never NULL.
 221    */
 222   const arch_register_req_t *(*get_irn_reg_req)(const void *self,
 223       arch_register_req_t *req, const ir_node *irn, int pos);
 224
 225   /**
 226    * Set the register for an output operand.
 227    * @param irn The node.
 228    * @param reg The register allocated to that operand.
 229    * @note      If the operand is not a register operand,
 230    *            the call is ignored.
 231    */
 232   void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 233
 234   /**
 235    * Get the register allocated for an output operand.
 236    * @param irn The node.
 237    * @return    The register allocated at that operand. NULL, if
 238    *            the operand was no register operand or
 239    *            @c arch_register_invalid, if no register has yet been
 240    *            allocated for this node.
 241    */
 242   const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 243
 244   /**
 245    * Classify the node.
 246    * @param irn The node.
 247    * @return A classification.
 248    */
 249   arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 250
 251   /**
 252    * Get the flags of a node.
 253    * @param self The irn ops themselves.
 254    * @param irn The node.
 255    * @return A set of flags.
 256    */
 257   arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 258
 259   /**
 260    * Get the entity on the stack frame this node depends on.
 261    * @param self The this pointer.
 262    * @param irn  The node in question.
 263    * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
 264    */
 265   entity *(*get_frame_entity)(const void *self, const ir_node *irn);
 266
 267   /**
 268    * Set the offset of a node carrying an entity on the stack frame.
 269    * @param self The this pointer.
 270    * @param irn  The node.
 271    * @param offset The offset of the node's stack frame entity.
 272    */
 273   void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
 274 };
 275
 276 /**
 277  * irn_ops base class.
 278  */
 279 struct _arch_irn_ops_t {
 280         const arch_irn_ops_if_t *impl;
 281 };
 282
 283 extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
 284
 285 extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
 286
 287 /**
 288  * Get the register requirements for a node.
 289  * @param env The architecture environment.
 290  * @param req A pointer to a requirements structure, where the data can
 291  *            be put into.
 292  * @param irn The node.
 293  * @param pos The position of the operand you're interested in.
 294  * @return    A pointer to the register requirements which may <b>not</b>
 295  *            neccessarily be equal to @p req. If NULL is returned, the
 296  *            operand was no register operand.
 297  */
 298 extern const arch_register_req_t *
 299 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 300     const ir_node *irn, int pos);
 301
 302 /**
 303  * Check if an operand is a register operand.
 304  * @param env The environment.
 305  * @param irn The node.
 306  * @param pos The position of the operand.
 307  * @return 1, if the operand is significant for register allocation, 0
 308  * if not.
 309  */
 310 extern int arch_is_register_operand(const arch_env_t *env,
 311     const ir_node *irn, int pos);
 312
 313 /**
 314  * Get the number of allocatable registers concerning
 315  * a register class for an operand of a node.
 316  * @param env The environment.
 317  * @param irn The node.
 318  * @param pos The postition of the node's operand.
 319  * @param bs  The bitset all allocatable registers shall be put into.
 320  *            Note, that you can also pass NULL here. If you don't,
 321  *            make sure, the bitset is as large as the register class
 322  *            has registers.
 323  * @return    The amount of registers allocatable for that operand.
 324  */
 325 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
 326
 327 /**
 328  * Put all registers which shall not be ignored by the register
 329  * allocator in a bit set.
 330  * @param env The arch env.
 331  * @param cls The register class to consider.
 332  * @param bs  The bit set to put the registers to.
 333  */
 334 extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
 335
 336 /**
 337  * Check, if a register is assignable to an operand of a node.
 338  * @param env The architecture environment.
 339  * @param irn The node.
 340  * @param pos The position of the operand.
 341  * @param reg The register.
 342  * @return    1, if the register might be allocated to the operand 0 if not.
 343  */
 344 extern int arch_reg_is_allocatable(const arch_env_t *env,
 345     const ir_node *irn, int pos, const arch_register_t *reg);
 346
 347 /**
 348  * Get the register class of an operand of a node.
 349  * @param env The architecture environment.
 350  * @param irn The node.
 351  * @param pos The position of the operand, -1 for the output.
 352  * @return    The register class of the operand or NULL, if
 353  *            operand is a non-register operand.
 354  */
 355 extern const arch_register_class_t *
 356 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 357
 358 /**
 359  * Get the register allocated at a certain output operand of a node.
 360  * @param env The arch environment.
 361  * @param irn The node.
 362  * @return    The register allocated for this operand
 363  */
 364 extern const arch_register_t *
 365 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 366
 367 /**
 368  * Set the register for a certain output operand.
 369  * @param env The architecture environment.
 370  * @param irn The node.
 371  * @param idx The index of the output operand.
 372  * @param reg The register.
 373  */
 374 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 375                 const arch_register_t *reg);
 376
 377 /**
 378  * Classify a node.
 379  * @param env The architecture environment.
 380  * @param irn The node.
 381  * @return A classification of the node.
 382  */
 383 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 384
 385 /**
 386  * Get the flags of a node.
 387  * @param env The architecture environment.
 388  * @param irn The node.
 389  * @return The flags.
 390  */
 391 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 392
 393 #define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
 394
 395 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 396   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 397
 398 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
 399         (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
 400
 401 /**
 402  * Somebody who can be asked about IR nodes.
 403  */
 404 struct _arch_irn_handler_t {
 405
 406   /**
 407     * Get the operations of an irn.
 408     * @param self The handler from which the method is invoked.
 409     * @param irn Some node.
 410     * @return Operations for that irn.
 411     */
 412   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
 413       const ir_node *irn);
 414 };
 415
 416 /**
 417  * The code generator interface.
 418  */
 419 struct _arch_code_generator_if_t {
 420         /**
 421          * Initialize the code generator.
 422          * @param birg A backend IRG session.
 423          * @return     A newly created code generator.
 424          */
 425         void *(*init)(const be_irg_t *birg);
 426
 427         /**
 428          * Called before abi introduce.
 429          */
 430         void (*before_abi)(void *self);
 431
 432         /**
 433          * Called, when the graph is being normalized.
 434          */
 435         void (*prepare_graph)(void *self);
 436
 437         /**
 438          * Called before scheduling.
 439          */
 440         void (*before_sched)(void *self);
 441
 442         /**
 443          * Called before register allocation.
 444          */
 445         void (*before_ra)(void *self);
 446
 447         /**
 448          * Called after register allocation.
 449          */
 450         void (*after_ra)(void *self);
 451
 452         /**
 453          * Called after everything happened.
 454          * The code generator must also be de-allocated here.
 455          */
 456         void (*done)(void *self);
 457 };
 458
 459 /**
 460  * helper macro: call function func from the code generator
 461  * if it's implemented.
 462  */
 463 #define _arch_cg_call(cg, func) \
 464 do { \
 465         if((cg)->impl->func) \
 466                 (cg)->impl->func(cg); \
 467 } while(0)
 468
 469 #define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 470 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 471 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 472 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 473 #define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 474 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 475
 476 /**
 477  * Code generator base class.
 478  */
 479 struct _arch_code_generator_t {
 480         const arch_code_generator_if_t *impl;
 481 };
 482
 483 /**
 484  * ISA base class.
 485  */
 486 struct _arch_isa_t {
 487         const arch_isa_if_t *impl;
 488         const arch_register_t *sp;  /** The stack pointer register. */
 489         const arch_register_t *bp;  /** The base pointer register. */
 490         const int stack_dir;        /** -1 for decreasing, 1 for increasing. */
 491 };
 492
 493 #define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
 494 #define arch_isa_sp(isa)         ((isa)->sp)
 495 #define arch_isa_bp(isa)         ((isa)->bp)
 496
 497 /**
 498  * Architecture interface.
 499  */
 500 struct _arch_isa_if_t {
 501
 502   /**
 503    * Initialize the isa interface.
 504          * @param file_handle  the file handle to write the output to
 505          * @return a new isa instance
 506    */
 507   void *(*init)(FILE *file_handle);
 508
 509   /**
 510    * Free the isa instance.
 511    */
 512   void (*done)(void *self);
 513
 514   /**
 515    * Get the the number of register classes in the isa.
 516    * @return The number of register classes.
 517    */
 518   int (*get_n_reg_class)(const void *self);
 519
 520   /**
 521    * Get the i-th register class.
 522    * @param i The number of the register class.
 523    * @return The register class.
 524    */
 525   const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 526
 527   /**
 528    * Get the register class which shall be used to store a value of a given mode.
 529    * @param self The this pointer.
 530    * @param mode The mode in question.
 531    * @return A register class which can hold values of the given mode.
 532    */
 533   const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
 534
 535   /**
 536    * Get the ABI restrictions for procedure calls.
 537    * @param self        The this pointer.
 538    * @param method_type The type of the method (procedure) in question.
 539    * @param p           The array of parameter locations to be filled.
 540    */
 541   void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
 542
 543   /**
 544    * The irn handler for this architecture.
 545    * The irn handler is registered by the Firm back end
 546    * when the architecture is initialized.
 547    * (May be NULL).
 548    */
 549   const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 550
 551   /**
 552    * Get the code generator interface.
 553    * @param self The this pointer.
 554    * @return     Some code generator interface.
 555    */
 556   const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 557
 558   /**
 559    * Get the list scheduler to use.
 560    * @param self  The isa object.
 561    * @return      The list scheduler selector.
 562    */
 563   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
 564
 565   /**
 566    * Get the necessary alignment for storing a register of given class.
 567    * @param self  The isa object.
 568    * @param cls   The register class.
 569    * @return      The alignment in bytes.
 570    */
 571   int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
 572
 573 #ifdef WITH_LIBCORE
 574         /**
 575          * Register command line options for this backend.
 576          * @param grp  The root group.
 577          */
 578   void (*register_options)(lc_opt_entry_t *grp);
 579 #endif
 580 };
 581
 582 #define arch_isa_get_n_reg_class(isa)                ((isa)->impl->get_n_reg_class(isa))
 583 #define arch_isa_get_reg_class(isa,i)                ((isa)->impl->get_reg_class(isa, i))
 584 #define arch_isa_get_irn_handler(isa)                ((isa)->impl->get_irn_handler(isa))
 585 #define arch_isa_get_call_abi(isa,tp,abi)            ((isa)->impl->get_call_abi((isa), (tp), (abi)))
 586 #define arch_isa_get_reg_class_for_mode(isa,mode)    ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
 587 #define arch_isa_make_code_generator(isa,irg)        ((isa)->impl->make_code_generator((isa), (irg)))
 588 #define arch_isa_get_reg_class_alignment(isa, cls)   ((isa)->impl->get_reg_class_alignment((isa), (cls)))
 589
 590 #define ARCH_MAX_HANDLERS         8
 591
 592 /**
 593  * Environment for the architecture infrastructure.
 594  * Keep this everywhere you're going.
 595  */
 596 struct _arch_env_t {
 597   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 598   arch_isa_t *isa;                                /**< The isa about which everything is. */
 599
 600   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 601                                                            a stack. */
 602
 603   int handlers_tos;                                   /**< The stack pointer of the handler
 604                                                         stack. */
 605 };
 606
 607 /**
 608  * Get the isa of an arch environment.
 609  * @param env The environment.
 610  * @return The isa with which the env was initialized with.
 611  */
 612 #define arch_env_get_isa(env)   ((env)->isa)
 613
 614 /**
 615  * Initialize the architecture environment struct.
 616  * @param isa           The isa which shall be put into the environment.
 617  * @param file_handle   The file handle
 618  * @return The environment.
 619  */
 620 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle);
 621
 622 /**
 623  * Add a node handler to the environment.
 624  * @param env The environment.
 625  * @param handler A node handler.
 626  * @return The environment itself.
 627  */
 628 extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
 629
 630 /**
 631  * Remove a node handler from the handler stack.
 632  * @param env The architecture environment.
 633  * @return The popped handler.
 634  */
 635 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 636
 637 #endif /* _FIRM_BEARCH_H */