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

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