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

   1
   2 #ifndef _FIRM_BEARCH_H
   3 #define _FIRM_BEARCH_H
   4
   5 #include "firm_config.h"
   6
   7 #include "irnode.h"
   8 #include "irmode.h"
   9
  10 #include "bitset.h"
  11 #include "hashptr.h"
  12 #include "fourcc.h"
  13 #include "set.h"
  14 #include "list.h"
  15 #include "ident.h"
  16
  17 typedef struct _arch_register_class_t   arch_register_class_t;
  18 typedef struct _arch_register_t         arch_register_t;
  19 typedef struct _arch_enum_t             arch_enum_t;
  20 typedef struct _arch_enum_member_t      arch_enum_member_t;
  21 typedef struct _arch_isa_if_t           arch_isa_if_t;
  22 typedef struct _arch_env_t              arch_env_t;
  23 typedef struct _arch_irn_ops_t          arch_irn_ops_t;
  24 typedef struct _arch_irn_handler_t      arch_irn_handler_t;
  25
  26 struct _be_node_factory_t;
  27
  28 typedef enum _arch_register_type_t {
  29         arch_register_type_none = 0,
  30   arch_register_type_write_invariant,
  31         arch_register_type_caller_saved,    /**< The register must be saved by the caller
  32                                         upon a function call. It thus can be overwritten
  33                                                                                                                                                                                                 in the called function. */
  34         arch_register_type_callee_saved,    /**< The register must be saved by the called function,
  35                                         it thus survives a function call. */
  36         arch_register_type_ignore           /**< Do not consider this register when allocating. */
  37 } arch_register_type_t;
  38
  39 /**
  40  * A register.
  41  */
  42 struct _arch_register_t {
  43   const char *name;                         /**< The name of the register. */
  44         const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
  45         int index;                                                                                                                              /**< The index of the register in the class. */
  46         arch_register_type_t type;                /**< The type of the register. */
  47   void *data;                               /**< Custom data. */
  48 };
  49
  50 static INLINE const arch_register_class_t *
  51 _arch_register_get_class(const arch_register_t *reg)
  52 {
  53   return reg->reg_class;
  54 }
  55
  56 static INLINE int _arch_register_get_index(const arch_register_t *reg)
  57 {
  58   return reg->index;
  59 }
  60
  61 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
  62 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
  63 #define arch_register_get_name(reg)       ((reg)->name)
  64
  65 /**
  66  * A class of registers.
  67  * Like general purpose or floating point.
  68  */
  69 struct _arch_register_class_t {
  70   const char *name;               /**< The name of the register. */
  71         int n_regs;                                                                   /**< Number of registers in this class. */
  72         const arch_register_t *regs;    /**< The array of registers. */
  73 };
  74
  75 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
  76
  77 /**
  78  * Put all registers in a class into a bitset.
  79  * @param cls The class.
  80  * @param bs The bitset. May be NULL.
  81  * @return The number of registers in the class.
  82  */
  83 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
  84
  85 static INLINE const arch_register_t *
  86 _arch_register_for_index(const arch_register_class_t *cls, int idx)
  87 {
  88         assert(0 <= idx && idx < cls->n_regs);
  89         return &cls->regs[idx];
  90 }
  91
  92 #define arch_register_for_index(cls, idx) \
  93   _arch_register_for_index(cls, idx)
  94
  95 /**
  96  * Get the register set for a register class.
  97  * @param cls The register class.
  98  * @return The set containing all registers in the class.
  99  */
 100 #define arch_get_register_set_for_class(cls) ((cls)->set)
 101
 102 /**
 103  * An immediate.
 104  */
 105 struct _arch_immediate_t {
 106   const char *name;         /**< The name of the immediate. */
 107         ir_mode *mode;                                          /**< The mode of the immediate. */
 108 };
 109
 110 /**
 111  * The member of an enum.
 112  */
 113 struct _arch_enum_member_t {
 114         arch_enum_t *enm;                                       /**< The enum, this member belongs to. */
 115 };
 116
 117 /**
 118  * An enumeration operand type.
 119  *
 120  * Enumeration operand types can be used to describe the variants
 121  * of an instruction, like giving the cases for a compare (gt, lt,
 122  * eq, ...) some other special attributes of an instruction.
 123  */
 124 struct _arch_enum_t {
 125         int n_members;                                                                          /**< The number of members in this enum. */
 126         arch_enum_member_t *members[1];         /**< The array of members. */
 127 };
 128
 129 typedef enum _arch_operand_type_t {
 130   arch_operand_type_invalid,
 131   arch_operand_type_memory,
 132   arch_operand_type_register,
 133   arch_operand_type_immediate,
 134   arch_operand_type_symconst,
 135         arch_operand_type_last
 136 } arch_operand_type_t;
 137
 138 /**
 139  * Different types of register allocation requirements.
 140  */
 141 typedef enum _arch_register_req_type_t {
 142   arch_register_req_type_none = 0,        /** No register requirement. */
 143
 144   arch_register_req_type_normal = 1,      /** All registers in the class
 145                                             are allowed. */
 146
 147   arch_register_req_type_limited = 2,     /** Only a real subset of
 148                                             the class is allowed. */
 149
 150   arch_register_req_type_equal = 4,       /** The register must equal
 151                                             another one at the node. */
 152
 153   arch_register_req_type_unequal = 8,     /** The register must be unequal
 154                                             to some other at the node. */
 155
 156   arch_register_req_type_pair = 16        /** The register is part of a
 157                                             register pair. */
 158 } arch_register_req_type_t;
 159
 160 #define arch_register_req_is_constr(x) \
 161   ((x)->type & (arch_register_req_type_pair + arch_register_req_type_limited - 1) != 0)
 162
 163 /**
 164  * Expresses requirements to register allocation for an operand.
 165  */
 166 typedef struct _arch_register_req_t {
 167   arch_register_req_type_t type;          /** The type of the constraint. */
 168   const arch_register_class_t *cls;       /** The register class this
 169                                             constraint belongs to. */
 170   union {
 171     int (*limited)(const ir_node *irn, int pos, bitset_t *bs);
 172                                           /** In case of the 'limited'
 173                                             constraint, this function
 174                                             must put all allowable
 175                                             registers in the bitset and
 176                                             return the number of registers
 177                                             in the bitset. */
 178
 179     int pos;                             /** In case of the equal constraint,
 180                                             this gives the position of the
 181                                             operand to which the register of
 182                                             this should be equal to. Same for
 183                                             unequal. */
 184   } data;
 185 } arch_register_req_t;
 186
 187 /**
 188  * Certain node classes which are relevent for the register allocator.
 189  */
 190 typedef enum _arch_irn_class_t {
 191   arch_irn_class_normal,
 192   arch_irn_class_spill,
 193   arch_irn_class_reload,
 194   arch_irn_class_copy,
 195   arch_irn_class_perm,
 196   arch_irn_class_branch
 197 } arch_irn_class_t;
 198
 199 /*
 200  * Some words about positions and indices:
 201  *
 202  * Firm has the policy "One node per value", that's why there are
 203  * Proj nodes. This view has its advantages, but in a backend
 204  * setting where we talk about instructions (which can also have
 205  * multiple results and not a single Tuple value) this is sometimes
 206  * hard.
 207  *
 208  * Each node representing an instruction must provide information
 209  * about the kind of its operands (where operands mean both input
 210  * and output operands). Such an operand is addressed with a position
 211  * which is infact a tuple {in, out} x N. The fact that a position
 212  * is an input/output operand is encoded in the sign, so input operands
 213  * go from 0..n-1 and output operands from -1..-m if the
 214  * instruction has n input and m output operands.
 215  */
 216
 217 #define _BEARCH_TRANSFORM_INDEX(cmp, index) ((index) cmp 0 ? -((index) + 1) : (index))
 218
 219 /**
 220  * Make an in position from an index.
 221  * @param index The index.
 222  * @return The position representing the index as an in operand.
 223  */
 224 #define arch_pos_make_in(index)   _BEARCH_TRANSFORM_INDEX(<, index)
 225
 226 /**
 227  * Make an out position from an index.
 228  * @param index The index.
 229  * @return The position representing the index as an out operand.
 230  */
 231 #define arch_pos_make_out(index)  _BEARCH_TRANSFORM_INDEX(>=, index)
 232
 233 /**
 234  * Check, if a position denotes an input operand.
 235  * @param pos The position.
 236  * @return 1, if the position denotes an input operand 0 if not.
 237  */
 238 #define arch_pos_is_in(pos)       ((pos) >= 0)
 239
 240 /**
 241  * Check, if a position denotes an output operand.
 242  * @param pos The position.
 243  * @return 1, if the position denotes an output operand 0 if not.
 244  */
 245 #define arch_pos_is_out(pos)      (!arch_pos_is_in(pos))
 246
 247 /**
 248  * Get the index of a position.
 249  * @param pos The position.
 250  * @return The index of the position.
 251  */
 252 #define arch_pos_get_index(pos)   _BEARCH_TRANSFORM_INDEX(<, pos)
 253
 254 struct _arch_irn_ops_t {
 255
 256   /**
 257    * Get the register requirements for a given operand.
 258    * @param self The self pointer.
 259    * @param irn The node.
 260    * @param pos The operand's position.
 261    * @return    The register requirements for the selected operand.
 262    *            The pointer returned is never NULL.
 263    */
 264   const arch_register_req_t *(*get_irn_reg_req)(const arch_irn_ops_t *self,
 265       arch_register_req_t *req,
 266       const ir_node *irn, int pos);
 267
 268   /**
 269    * Get the number of operands of a node.
 270    * @param irn     The node.
 271    * @param in_out  Denotes wither input (a number >= 0) or
 272    *                output (a number < 0).
 273    * @return        The number of operands for either in, or output.
 274    */
 275   int (*get_n_operands)(const arch_irn_ops_t *self, const ir_node *irn, int in_out);
 276
 277   /**
 278    * Set the register for an output operand.
 279    * @param irn The node.
 280    * @param pos The position of the output operand.
 281    * @param reg The register allocated to that operand.
 282    * @note      If the operand is not a register operand,
 283    *            the call is ignored.
 284    */
 285   void (*set_irn_reg)(const arch_irn_ops_t *self, ir_node *irn,
 286       int idx, const arch_register_t *reg);
 287
 288   /**
 289    * Get the register allocated for an output operand.
 290    * @param irn The node.
 291    * @param pos The index of the output operand.
 292    * @return    The register allocated at that operand. NULL, if
 293    *            the operand was no register operand or
 294    *            @c arch_register_invalid, if no register has yet been
 295    *            allocated for this node.
 296    */
 297   const arch_register_t *(*get_irn_reg)(const arch_irn_ops_t *self,
 298       const ir_node *irn, int idx);
 299
 300   /**
 301    * Classify the node.
 302    * @param irn The node.
 303    * @return A classification.
 304    */
 305   arch_irn_class_t (*classify)(const arch_irn_ops_t *self, const ir_node *irn);
 306
 307 };
 308
 309 /**
 310  * Get the register requirements for a node.
 311  * @param env The architecture environment.
 312  * @param req A pointer to a requirements structure, where the data can
 313  *            be put into.
 314  * @param irn The node.
 315  * @param pos The position of the operand you're interested in.
 316  * @return    A pointer to the register requirements which may <b>not</b>
 317  *            neccessarily be equal to @p req. If NULL is returned, the
 318  *            operand was no register operand.
 319  */
 320 extern const arch_register_req_t *
 321 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
 322     const ir_node *irn, int pos);
 323
 324 /**
 325  * Check if an operand is a register operand.
 326  * @param env The environment.
 327  * @param irn The node.
 328  * @param pos The position of the operand.
 329  * @return 1, if the operand is significant for register allocation, 0
 330  * if not.
 331  */
 332 extern int arch_is_register_operand(const arch_env_t *env,
 333     const ir_node *irn, int pos);
 334
 335 /**
 336  * Get the number of allocatable registers concerning
 337  * a register class for an operand of a node.
 338  * @param env The environment.
 339  * @param irn The node.
 340  * @param pos The postition of the node's operand.
 341  * @param cls The register class.
 342  * @param bs  The bitset all allocatable registers shall be put into.
 343  *            Note, that you can also pass NULL here. If you don't,
 344  *            make sure, the bitset is as large as the register class
 345  *            has registers.
 346  * @return    The amount of registers allocatable for that operand.
 347  */
 348 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
 349     int pos, const arch_register_class_t *cls, bitset_t *bs);
 350
 351 /**
 352  * Check, if a register is assignable to an operand of a node.
 353  * @param env The architecture environment.
 354  * @param irn The node.
 355  * @param pos The position of the operand.
 356  * @param reg The register.
 357  * @return    1, if the register might be allocated to the operand 0 if not.
 358  */
 359 extern int arch_reg_is_allocatable(const arch_env_t *env,
 360     const ir_node *irn, int pos, const arch_register_t *reg);
 361
 362 /**
 363  * Get the register class of an operand of a node.
 364  * @param env The architecture environment.
 365  * @param irn The node.
 366  * @param idx The position of the operand.
 367  * @return    The register class of the operand or NULL, if
 368  *            operand is a non-register operand.
 369  */
 370 extern const arch_register_class_t *
 371 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
 372
 373 /**
 374  * Get the register allocated at a certain output operand of a node.
 375  * @param env The arch nvironment.
 376  * @param irn The node.
 377  * @param idx The index of the output operand.
 378  * @return    The register allocated for this operand
 379  */
 380 extern const arch_register_t *
 381 arch_get_irn_register(const arch_env_t *env, const ir_node *irn, int idx);
 382
 383 /**
 384  * Set the register for a certain output operand.
 385  * @param env The architecture environment.
 386  * @param irn The node.
 387  * @param idx The index of the output operand.
 388  * @param reg The register.
 389  */
 390 extern void arch_set_irn_register(const arch_env_t *env,
 391     ir_node *irn, int idx, const arch_register_t *reg);
 392
 393 /**
 394  * Classify a node.
 395  * @param env The architecture environment.
 396  * @param irn The node.
 397  * @return A classification of the node.
 398  */
 399 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 400
 401 #define arch_irn_has_reg_class(env, irn, pos, cls) \
 402   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 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 arch_irn_ops_t *(*get_irn_ops)(const arch_irn_handler_t *handler,
 416       const ir_node *irn);
 417
 418 };
 419
 420 /**
 421  * Architecture interface.
 422  */
 423 struct _arch_isa_if_t {
 424
 425   /**
 426    * Initialize the isa interface.
 427    */
 428   void (*init)(void);
 429
 430   /**
 431    * Get the the number of register classes in the isa.
 432    * @return The number of register classes.
 433    */
 434   int (*get_n_reg_class)(void);
 435
 436   /**
 437    * Get the i-th register class.
 438    * @param i The number of the register class.
 439    * @return The register class.
 440    */
 441   const arch_register_class_t *(*get_reg_class)(int i);
 442
 443 };
 444
 445 #define ARCH_MAX_HANDLERS         8
 446
 447 /**
 448  * Environment for the architecture infrastructure.
 449  * Keep this everywhere you're going.
 450  */
 451 struct _arch_env_t {
 452   const struct _be_node_factory_t *node_factory;  /**< The node factory for be nodes. */
 453   const arch_isa_if_t *isa;               /**< The isa about which everything is. */
 454
 455   arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
 456                                                            a stack. */
 457
 458   int handlers_tos;                                   /**< The stack pointer of the handler
 459                                                         stack. */
 460 };
 461
 462 /**
 463  * Get the isa of an arch environment.
 464  * @param env The environment.
 465  * @return The isa with which the env was initialized with.
 466  */
 467 #define arch_env_get_isa(env)   ((env)->isa)
 468
 469 /**
 470  * Initialize the architecture environment struct.
 471  * @param isa The isa which shall be put into the environment.
 472  * @return The environment.
 473  */
 474 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
 475
 476 /**
 477  * Add a node handler to the environment.
 478  * @param env The environment.
 479  * @param handler A node handler.
 480  * @return The environment itself.
 481  */
 482 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
 483     const arch_irn_handler_t *handler);
 484
 485 #endif /* _FIRM_BEARCH_H */