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