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 "irnode.h"
  11 #include "irmode.h"
  12
  13 #include "bitset.h"
  14 #include "hashptr.h"
  15 #include "fourcc.h"
  16 #include "set.h"
  17 #include "list.h"
  18 #include "ident.h"
  19
  20 #include "belistsched.h"
  21
  22 typedef struct _arch_register_class_t     arch_register_class_t;
  23 typedef struct _arch_register_t           arch_register_t;
  24 typedef struct _arch_enum_t               arch_enum_t;
  25 typedef struct _arch_enum_member_t        arch_enum_member_t;
  26 typedef struct _arch_isa_if_t             arch_isa_if_t;
  27 typedef struct _arch_isa_t                arch_isa_t;
  28 typedef struct _arch_env_t                arch_env_t;
  29 typedef struct _arch_irn_ops_t            arch_irn_ops_t;
  30 typedef struct _arch_irn_handler_t        arch_irn_handler_t;
  31 typedef struct _arch_code_generator_t     arch_code_generator_t;
  32 typedef struct _arch_code_generator_if_t  arch_code_generator_if_t;
  33
  34 struct _be_node_factory_t;
  35
  36 typedef enum _arch_register_type_t {
  37   arch_register_type_none = 0,
  38   arch_register_type_write_invariant,
  39   arch_register_type_caller_saved,    /**< The register must be saved by the caller
  40                                            upon a function call. It thus can be overwritten
  41                                            in the called function. */
  42   arch_register_type_callee_saved,    /**< The register must be saved by the called function,
  43                                            it thus survives a function call. */
  44   arch_register_type_ignore           /**< Do not consider this register when allocating. */
  45 } arch_register_type_t;
  46
  47 /**
  48  * A register.
  49  */
  50 struct _arch_register_t {
  51   const char *name;                         /**< The name of the register. */
  52   const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  53   int index;                                /**< The index of the register in the class. */
  54   arch_register_type_t type;                /**< The type of the register. */
  55   void *data;                               /**< Custom data. */
  56 };
  57
  58 static INLINE const arch_register_class_t *
  59 _arch_register_get_class(const arch_register_t *reg)
  60 {
  61   return reg->reg_class;
  62 }
  63
  64 static INLINE int _arch_register_get_index(const arch_register_t *reg)
  65 {
  66   return reg->index;
  67 }
  68
  69 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  70 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  71 #define arch_register_get_name(reg)       ((reg)->name)
  72
  73 /**
  74  * A class of registers.
  75  * Like general purpose or floating point.
  76  */
  77 struct _arch_register_class_t {
  78   const char *name;               /**< The name of the register class. */
  79   int n_regs;                     /**< Number of registers in this class. */
  80   const arch_register_t *regs;    /**< The array of registers. */
  81 };
  82
  83 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  84
  85 /**
  86  * Put all registers in a class into a bitset.
  87  * @param cls The class.
  88  * @param bs The bitset. May be NULL.
  89  * @return The number of registers in the class.
  90  */
  91 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
  92
  93 static INLINE const arch_register_t *
  94 _arch_register_for_index(const arch_register_class_t *cls, int idx)
  95 {
  96   assert(0 <= idx && idx < cls->n_regs);
  97   return &cls->regs[idx];
  98 }
  99
 100 #define arch_register_for_index(cls, idx) \
 101   _arch_register_for_index(cls, idx)
 102
 103 /**
 104  * Get the register set for a register class.
 105  * @param cls The register class.
 106  * @return The set containing all registers in the class.
 107  */
 108 #define arch_get_register_set_for_class(cls) ((cls)->set)
 109
 110 /**
 111  * An immediate.
 112  */
 113 struct _arch_immediate_t {
 114   const char *name;         /**< The name of the immediate. */
 115   ir_mode *mode;            /**< The mode of the immediate. */
 116 };
 117
 118 /**
 119  * The member of an enum.
 120  */
 121 struct _arch_enum_member_t {
 122   arch_enum_t *enm;         /**< The enum, this member belongs to. */
 123 };
 124
 125 /**
 126  * An enumeration operand type.
 127  *
 128  * Enumeration operand types can be used to describe the variants
 129  * of an instruction, like giving the cases for a compare (gt, lt,
 130  * eq, ...) some other special attributes of an instruction.
 131  */
 132 struct _arch_enum_t {
 133   int n_members;                    /**< The number of members in this enum. */
 134   arch_enum_member_t *members[1];   /**< The array of members. */
 135 };
 136
 137 typedef enum _arch_operand_type_t {
 138   arch_operand_type_invalid,
 139   arch_operand_type_memory,
 140   arch_operand_type_register,
 141   arch_operand_type_immediate,
 142   arch_operand_type_symconst,
 143   arch_operand_type_last
 144 } arch_operand_type_t;
 145
 146 /**
 147  * Different types of register allocation requirements.
 148  */
 149 typedef enum _arch_register_req_type_t {
 150   arch_register_req_type_none = 0,        /**< No register requirement. */
 151
 152   arch_register_req_type_normal = 1,      /**< All registers in the class
 153                                                are allowed. */
 154
 155   arch_register_req_type_limited = 2,     /**< Only a real subset of
 156                                                the class is allowed. */
 157
 158   arch_register_req_type_should_be_same = 4,       /**< The register should be equal
 159                                                         another one at the node. */
 160
 161   arch_register_req_type_should_be_different = 8,  /**< The register must be unequal
 162                                                         to some other at the node. */
 163
 164 } arch_register_req_type_t;
 165
 166 #define arch_register_req_is_constr(x) \
 167   ((x)->type & (arch_register_req_type_pair + arch_register_req_type_limited - 1) != 0)
 168
 169 /**
 170  * Expresses requirements to register allocation for an operand.
 171  */
 172 typedef struct _arch_register_req_t {
 173   arch_register_req_type_t type;          /**< The type of the constraint. */
 174   const arch_register_class_t *cls;       /**< The register class this
 175                                                constraint belongs to. */
 176   union {
 177     int (*limited)(const ir_node *irn, int pos, bitset_t *bs);
 178                                           /**< In case of the 'limited'
 179                                             constraint, this function
 180                                             must put all allowable
 181                                             registers in the bitset and
 182                                             return the number of registers
 183                                             in the bitset. */
 184
 185     int pos;                             /**< In case of the equal constraint,
 186                                             this gives the position of the
 187                                             operand to which the register of
 188                                             this should be equal to. Same for
 189                                             unequal. */
 190   } data;
 191 } arch_register_req_t;
 192
 193 /**
 194  * Certain node classes which are relevent for the register allocator.
 195  */
 196 typedef enum _arch_irn_class_t {
 197   arch_irn_class_normal,
 198   arch_irn_class_spill,
 199   arch_irn_class_reload,
 200   arch_irn_class_copy,
 201   arch_irn_class_perm,
 202   arch_irn_class_branch
 203 } arch_irn_class_t;
 204
 205 /**
 206  * Some flags describing a node in more detail.
 207  */
 208 typedef enum _arch_irn_flags_t {
 209   arch_irn_flags_spillable = 1,
 210   arch_irn_flags_rematerializable = 2
 211 } arch_irn_flags_t;
 212
 213 struct _arch_irn_ops_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 arch_irn_ops_t *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 arch_irn_ops_t *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 arch_irn_ops_t *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 arch_irn_ops_t *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 arch_irn_ops_t *self, const ir_node *irn);
 261
 262 };
 263
 264 /**
 265  * Get the register requirements for a node.
 266  * @param env The architecture environment.
 267  * @param req A pointer to a requirements structure, where the data can
 268  *            be put into.
 269  * @param irn The node.
 270  * @param pos The position of the operand you're interested in.
 271  * @return    A pointer to the register requirements which may <b>not</b>
 272  *            neccessarily be equal to @p req. If NULL is returned, the
 273  *            operand was no register operand.
 274  */
 275 extern const arch_register_req_t *
 276 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 277     const ir_node *irn, int pos);
 278
 279 /**
 280  * Check if an operand is a register operand.
 281  * @param env The environment.
 282  * @param irn The node.
 283  * @param pos The position of the operand.
 284  * @return 1, if the operand is significant for register allocation, 0
 285  * if not.
 286  */
 287 extern int arch_is_register_operand(const arch_env_t *env,
 288     const ir_node *irn, int pos);
 289
 290 /**
 291  * Get the number of allocatable registers concerning
 292  * a register class for an operand of a node.
 293  * @param env The environment.
 294  * @param irn The node.
 295  * @param pos The postition of the node's operand.
 296  * @param cls The register class.
 297  * @param bs  The bitset all allocatable registers shall be put into.
 298  *            Note, that you can also pass NULL here. If you don't,
 299  *            make sure, the bitset is as large as the register class
 300  *            has registers.
 301  * @return    The amount of registers allocatable for that operand.
 302  */
 303 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
 304     int pos, const arch_register_class_t *cls, bitset_t *bs);
 305
 306 /**
 307  * Check, if a register is assignable to an operand of a node.
 308  * @param env The architecture environment.
 309  * @param irn The node.
 310  * @param pos The position of the operand.
 311  * @param reg The register.
 312  * @return    1, if the register might be allocated to the operand 0 if not.
 313  */
 314 extern int arch_reg_is_allocatable(const arch_env_t *env,
 315     const ir_node *irn, int pos, const arch_register_t *reg);
 316
 317 /**
 318  * Get the register class of an operand of a node.
 319  * @param env The architecture environment.
 320  * @param irn The node.
 321  * @param pos The position of the operand.
 322  * @return    The register class of the operand or NULL, if
 323  *            operand is a non-register operand.
 324  */
 325 extern const arch_register_class_t *
 326 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 327
 328 /**
 329  * Get the register allocated at a certain output operand of a node.
 330  * @param env The arch nvironment.
 331  * @param irn The node.
 332  * @return    The register allocated for this operand
 333  */
 334 extern const arch_register_t *
 335 arch_get_irn_register(const arch_env_t *env, const ir_node *irn);
 336
 337 /**
 338  * Set the register for a certain output operand.
 339  * @param env The architecture environment.
 340  * @param irn The node.
 341  * @param idx The index of the output operand.
 342  * @param reg The register.
 343  */
 344 extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
 345                 const arch_register_t *reg);
 346
 347 /**
 348  * Classify a node.
 349  * @param env The architecture environment.
 350  * @param irn The node.
 351  * @return A classification of the node.
 352  */
 353 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 354
 355 /**
 356  * Get the flags of a node.
 357  * @param env The architecture environment.
 358  * @param irn The node.
 359  * @return The flags.
 360  */
 361 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 362
 363 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 364   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 365
 366 /**
 367  * Somebody who can be asked about nodes.
 368  */
 369 struct _arch_irn_handler_t {
 370
 371   /**
 372     * Get the operations of an irn.
 373     * @param self The handler from which the method is invoked.
 374     * @param irn Some node.
 375     * @return Operations for that irn.
 376     */
 377   const arch_irn_ops_t *(*get_irn_ops)(const arch_irn_handler_t *handler,
 378       const ir_node *irn);
 379
 380 };
 381
 382 /**
 383  * The code generator.
 384  */
 385 struct _arch_code_generator_if_t {
 386
 387
 388         /**
 389          * Initialzie the code generator.
 390          * @param file The file to dump to.
 391          * @param irg  The fucntion to generate code for.
 392          * @param env  The archicture environment.
 393          * @return     A newly created code generator.
 394          */
 395         void *(*init)(FILE *file, ir_graph *irg, const arch_env_t *env);
 396
 397         /**
 398          * Called, when the graph is being normalized.
 399          */
 400         void (*prepare_graph)(void *self);
 401
 402         /**
 403          * Called before scheduling.
 404          */
 405         void (*before_sched)(void *self);
 406
 407         /**
 408          * Called before register allocation.
 409          */
 410         void (*before_ra)(void *self);
 411
 412         /**
 413          * Called after everything happened.
 414          * The code generator must also be de-allocated here.
 415          */
 416         void (*done)(void *self);
 417
 418 };
 419
 420 #define _arch_cg_call(cg, func) \
 421 do { \
 422         if((cg)->impl->func) \
 423                 (cg)->impl->func(cg); \
 424 } while(0)
 425
 426 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 427 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 428 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
 429 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 430
 431 /**
 432  * Code generator base class.
 433  */
 434 struct _arch_code_generator_t {
 435         const arch_code_generator_if_t *impl;
 436 };
 437
 438 /**
 439  * ISA base class.
 440  */
 441 struct _arch_isa_t {
 442         const arch_isa_if_t *impl;
 443 };
 444
 445 /**
 446  * Architecture interface.
 447  */
 448 struct _arch_isa_if_t {
 449
 450 #ifdef WITH_LIBCORE
 451   void (*register_options)(lc_opt_entry_t *grp);
 452 #endif
 453
 454   /**
 455    * Initialize the isa interface.
 456    */
 457   void *(*init)(void);
 458
 459   /**
 460    * Free the isa instance.
 461    */
 462   void (*done)(void *self);
 463
 464   /**
 465    * Get the the number of register classes in the isa.
 466    * @return The number of register classes.
 467    */
 468   int (*get_n_reg_class)(const void *self);
 469
 470   /**
 471    * Get the i-th register class.
 472    * @param i The number of the register class.
 473    * @return The register class.
 474    */
 475   const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 476
 477   /**
 478    * The irn handler for this architecture.
 479    * The irn handler is registered by the Firm back end
 480    * when the architecture is initialized.
 481    * (May be NULL).
 482    */
 483   const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 484
 485   /**
 486    * Get the code generator interface.
 487    * @param self The this pointer.
 488    * @return     Some code generator interface.
 489    */
 490   const arch_code_generator_if_t *(*get_code_generator)(void *self);
 491
 492   /**
 493    * Get the list scheduler to use.
 494    * @param self  The isa object.
 495    * @return      The list scheduler selector.
 496    */
 497   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
 498 };
 499
 500 #define arch_isa_get_n_reg_class(isa)           ((isa)->impl->get_n_reg_class(isa))
 501 #define arch_isa_get_reg_class(isa,i)           ((isa)->impl->get_reg_class(isa, i))
 502 #define arch_isa_get_irn_handler(isa)           ((isa)->impl->get_irn_handler(isa))
 503 #define arch_isa_make_code_generator(isa,irg)   ((isa)->impl->make_code_generator(isa, irg))
 504
 505 #define ARCH_MAX_HANDLERS         8
 506
 507 /**
 508  * Environment for the architecture infrastructure.
 509  * Keep this everywhere you're going.
 510  */
 511 struct _arch_env_t {
 512   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 513   arch_isa_t *isa;                                /**< The isa about which everything is. */
 514
 515   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 516                                                            a stack. */
 517
 518   int handlers_tos;                                   /**< The stack pointer of the handler
 519                                                         stack. */
 520 };
 521
 522 /**
 523  * Get the isa of an arch environment.
 524  * @param env The environment.
 525  * @return The isa with which the env was initialized with.
 526  */
 527 #define arch_env_get_isa(env)   ((env)->isa)
 528
 529 /**
 530  * Initialize the architecture environment struct.
 531  * @param isa The isa which shall be put into the environment.
 532  * @return The environment.
 533  */
 534 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
 535
 536 /**
 537  * Add a node handler to the environment.
 538  * @param env The environment.
 539  * @param handler A node handler.
 540  * @return The environment itself.
 541  */
 542 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
 543     const arch_irn_handler_t *handler);
 544
 545 #endif /* _FIRM_BEARCH_H */