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

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Processor architecture specification.
  23  * @author      Sebastian Hack
  24  */
  25 #ifndef FIRM_BE_BEARCH_H
  26 #define FIRM_BE_BEARCH_H
  27
  28 #include <stdbool.h>
  29
  30 #include "firm_types.h"
  31 #include "raw_bitset.h"
  32
  33 #include "be_types.h"
  34 #include "beinfo.h"
  35 #include "be.h"
  36
  37 /**
  38  * this constant is returned by the get_sp_bias functions if the stack
  39  * is reset (usually because the frame pointer is copied to the stack
  40  * pointer
  41  */
  42 #define SP_BIAS_RESET      INT_MIN
  43
  44 typedef enum arch_register_class_flags_t {
  45         arch_register_class_flag_none      = 0,
  46         /** don't do automatic register allocation for this class */
  47         arch_register_class_flag_manual_ra = 1U << 0,
  48         /** the register models an abstract state (example: fpu rounding mode) */
  49         arch_register_class_flag_state     = 1U << 1
  50 } arch_register_class_flags_t;
  51 ENUM_BITSET(arch_register_class_flags_t)
  52
  53 typedef enum arch_register_type_t {
  54         arch_register_type_none         = 0,
  55         /** Do not consider this register when allocating. */
  56         arch_register_type_ignore       = 1U << 0,
  57         /** This is just a virtual register. Virtual registers fulfill any register
  58          * constraints as long as the register class matches. It is a allowed to
  59          * have multiple definitions for the same virtual register at a point */
  60         arch_register_type_virtual      = 1U << 1,
  61         /** The register represents a state that should be handled by bestate
  62          * code */
  63         arch_register_type_state        = 1U << 2,
  64 } arch_register_type_t;
  65 ENUM_BITSET(arch_register_type_t)
  66
  67 /**
  68  * Different types of register allocation requirements.
  69  */
  70 typedef enum arch_register_req_type_t {
  71         /** No register requirement. */
  72         arch_register_req_type_none              = 0,
  73         /** All registers in the class are allowed. */
  74         arch_register_req_type_normal            = 1U << 0,
  75         /** Only a real subset of the class is allowed. */
  76         arch_register_req_type_limited           = 1U << 1,
  77         /** The register should be equal to another one at the node. */
  78         arch_register_req_type_should_be_same    = 1U << 2,
  79         /** The register must be unequal from some other at the node. */
  80         arch_register_req_type_must_be_different = 1U << 3,
  81         /** The registernumber should be aligned (in case of multiregister values)*/
  82         arch_register_req_type_aligned           = 1U << 4,
  83         /** ignore while allocating registers */
  84         arch_register_req_type_ignore            = 1U << 5,
  85         /** the output produces a new value for the stack pointer
  86          * (this is not really a constraint but a marker to guide the stackpointer
  87          * rewiring logic) */
  88         arch_register_req_type_produces_sp       = 1U << 6,
  89 } arch_register_req_type_t;
  90 ENUM_BITSET(arch_register_req_type_t)
  91
  92 extern arch_register_req_t const arch_no_requirement;
  93 #define arch_no_register_req (&arch_no_requirement)
  94
  95 /**
  96  * Print information about a register requirement in human readable form
  97  * @param F   output stream/file
  98  * @param req The requirements structure to format.
  99  */
 100 void arch_dump_register_req(FILE *F, const arch_register_req_t *req,
 101                             const ir_node *node);
 102
 103 void arch_dump_register_reqs(FILE *F, const ir_node *node);
 104 void arch_dump_reqs_and_registers(FILE *F, const ir_node *node);
 105
 106 void arch_set_frame_offset(ir_node *irn, int bias);
 107
 108 ir_entity *arch_get_frame_entity(const ir_node *irn);
 109 int        arch_get_sp_bias(ir_node *irn);
 110
 111 int             arch_get_op_estimated_cost(const ir_node *irn);
 112 int             arch_possible_memory_operand(const ir_node *irn,
 113                                              unsigned int i);
 114 void            arch_perform_memory_operand(ir_node *irn, ir_node *spill,
 115                                             unsigned int i);
 116
 117 /**
 118  * Get the register allocated for a value.
 119  */
 120 const arch_register_t *arch_get_irn_register(const ir_node *irn);
 121
 122 /**
 123  * Assign register to a value
 124  */
 125 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
 126
 127 /**
 128  * Set the register for a certain output operand.
 129  */
 130 void arch_set_irn_register_out(ir_node *irn, unsigned pos, const arch_register_t *r);
 131
 132 const arch_register_t *arch_get_irn_register_out(const ir_node *irn, unsigned pos);
 133 const arch_register_t *arch_get_irn_register_in(const ir_node *irn, int pos);
 134
 135 /**
 136  * Get register constraints for an operand at position @p
 137  */
 138 static inline const arch_register_req_t *arch_get_irn_register_req_in(
 139                 const ir_node *node, int pos)
 140 {
 141         const backend_info_t *info = be_get_info(node);
 142         return info->in_reqs[pos];
 143 }
 144
 145 /**
 146  * Get register constraint for a produced result (the @p pos result)
 147  */
 148 static inline const arch_register_req_t *arch_get_irn_register_req_out(
 149                 const ir_node *node, unsigned pos)
 150 {
 151         const backend_info_t *info = be_get_info(node);
 152         return info->out_infos[pos].req;
 153 }
 154
 155 static inline void arch_set_irn_register_req_out(ir_node *node, unsigned pos,
 156                 const arch_register_req_t *req)
 157 {
 158         backend_info_t *info = be_get_info(node);
 159         assert(pos < (unsigned)ARR_LEN(info->out_infos));
 160         info->out_infos[pos].req = req;
 161 }
 162
 163 static inline void arch_set_irn_register_reqs_in(ir_node *node,
 164                 const arch_register_req_t **reqs)
 165 {
 166         backend_info_t *info = be_get_info(node);
 167         info->in_reqs = reqs;
 168 }
 169
 170 static inline const arch_register_req_t **arch_get_irn_register_reqs_in(
 171                 const ir_node *node)
 172 {
 173         backend_info_t *info = be_get_info(node);
 174         return info->in_reqs;
 175 }
 176
 177 const arch_register_req_t *arch_get_irn_register_req(const ir_node *node);
 178
 179 /**
 180  * Get the flags of a node.
 181  * @param irn The node.
 182  * @return The flags.
 183  */
 184 arch_irn_flags_t arch_get_irn_flags(const ir_node *irn);
 185
 186 void arch_set_irn_flags(ir_node *node, arch_irn_flags_t flags);
 187 void arch_add_irn_flags(ir_node *node, arch_irn_flags_t flags);
 188
 189 #define arch_irn_is(irn, flag) ((arch_get_irn_flags(irn) & arch_irn_flags_ ## flag) != 0)
 190
 191 static inline unsigned arch_get_irn_n_outs(const ir_node *node)
 192 {
 193         backend_info_t *info = be_get_info(node);
 194         if (info->out_infos == NULL)
 195                 return 0;
 196
 197         return (unsigned)ARR_LEN(info->out_infos);
 198 }
 199
 200 /**
 201  * Start codegeneration
 202  */
 203 arch_env_t *arch_env_begin_codegeneration(const arch_isa_if_t *isa,
 204                                           be_main_env_t *main_env);
 205
 206 /**
 207  * Register an instruction set architecture
 208  */
 209 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
 210
 211 /**
 212  * A register.
 213  */
 214 struct arch_register_t {
 215         const char                  *name;         /**< The name of the register. */
 216         const arch_register_class_t *reg_class;    /**< The class of the register */
 217         unsigned short               index;        /**< The index of the register in
 218                                                         the class. */
 219         unsigned short               global_index; /**< The global index this
 220                                                                                                     register in the architecture. */
 221         arch_register_type_t         type;         /**< The type of the register. */
 222         /** register constraint allowing just this register */
 223         const arch_register_req_t   *single_req;
 224         /** register number in dwarf debugging format */
 225         unsigned short               dwarf_number;
 226 };
 227
 228 /**
 229  * A class of registers.
 230  * Like general purpose or floating point.
 231  */
 232 struct arch_register_class_t {
 233         unsigned                     index;   /**< index of this register class */
 234         const char                  *name;    /**< The name of the register class.*/
 235         unsigned                     n_regs;  /**< Number of registers in this
 236                                                    class. */
 237         ir_mode                     *mode;    /**< The mode of the register class.*/
 238         const arch_register_t       *regs;    /**< The array of registers. */
 239         arch_register_class_flags_t  flags;   /**< register class flags. */
 240         const arch_register_req_t   *class_req;
 241 };
 242
 243 /** return the number of registers in this register class */
 244 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
 245
 246 /** return the largest mode of this register class */
 247 #define arch_register_class_mode(cls) ((cls)->mode)
 248
 249 /** return the name of this register class */
 250 #define arch_register_class_name(cls) ((cls)->name)
 251
 252 /** return the index of this register class */
 253 #define arch_register_class_index(cls)  ((cls)->index)
 254
 255 /** return the register class flags */
 256 #define arch_register_class_flags(cls) ((cls)->flags)
 257
 258 static inline const arch_register_t *arch_register_for_index(
 259                 const arch_register_class_t *cls, unsigned idx)
 260 {
 261         assert(idx < cls->n_regs);
 262         return &cls->regs[idx];
 263 }
 264
 265 /**
 266  * Convenience macro to check for set constraints.
 267  * @param req   A pointer to register requirements.
 268  * @param kind  The kind of constraint to check for
 269  *              (see arch_register_req_type_t).
 270  * @return      1, If the kind of constraint is present, 0 if not.
 271  */
 272 #define arch_register_req_is(req, kind) \
 273         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 274
 275 /**
 276  * Expresses requirements to register allocation for an operand.
 277  */
 278 struct arch_register_req_t {
 279         arch_register_req_type_t     type; /**< The type of the constraint. */
 280         const arch_register_class_t *cls;  /**< The register class this constraint
 281                                                 belongs to. */
 282         const unsigned *limited;           /**< allowed register bitset
 283                                                 (in case of wide-values this is
 284                                                  only about the first register) */
 285         unsigned other_same;               /**< Bitmask of ins which should use the
 286                                                 same register (should_be_same). */
 287         unsigned other_different;          /**< Bitmask of ins which shall use a
 288                                                 different register
 289                                                 (must_be_different) */
 290         unsigned char width;               /**< specifies how many sequential
 291                                                 registers are required */
 292 };
 293
 294 static inline bool reg_reqs_equal(const arch_register_req_t *req1,
 295                                   const arch_register_req_t *req2)
 296 {
 297         if (req1 == req2)
 298                 return true;
 299
 300         if (req1->type              != req2->type            ||
 301             req1->cls               != req2->cls             ||
 302             req1->other_same        != req2->other_same      ||
 303             req1->other_different   != req2->other_different ||
 304             (req1->limited != NULL) != (req2->limited != NULL))
 305                 return false;
 306
 307         if (req1->limited != NULL) {
 308                 size_t const n_regs = arch_register_class_n_regs(req1->cls);
 309                 if (!rbitsets_equal(req1->limited, req2->limited, n_regs))
 310                         return false;
 311         }
 312
 313         return true;
 314 }
 315
 316 struct arch_irn_ops_t {
 317
 318         /**
 319          * Get the entity on the stack frame this node depends on.
 320          * @param irn  The node in question.
 321          * @return The entity on the stack frame or NULL, if the node does not have
 322          *         a stack frame entity.
 323          */
 324         ir_entity *(*get_frame_entity)(const ir_node *irn);
 325
 326         /**
 327          * Set the offset of a node carrying an entity on the stack frame.
 328          * @param irn  The node.
 329          * @param offset The offset of the node's stack frame entity.
 330          */
 331         void (*set_frame_offset)(ir_node *irn, int offset);
 332
 333         /**
 334          * Returns the delta of the stackpointer for nodes that increment or
 335          * decrement the stackpointer with a constant value. (push, pop
 336          * nodes on most architectures).
 337          * A positive value stands for an expanding stack area, a negative value for
 338          * a shrinking one.
 339          *
 340          * @param irn       The node
 341          * @return          0 if the stackpointer is not modified with a constant
 342          *                  value, otherwise the increment/decrement value
 343          */
 344         int (*get_sp_bias)(const ir_node *irn);
 345
 346         /**
 347          * Get the estimated cycle count for @p irn.
 348          *
 349          * @param irn  The node.
 350          * @return     The estimated cycle count for this operation
 351          */
 352         int (*get_op_estimated_cost)(const ir_node *irn);
 353
 354         /**
 355          * Asks the backend whether operand @p i of @p irn can be loaded form memory
 356          * internally
 357          *
 358          * @param irn  The node.
 359          * @param i    Index of the argument we would like to know whether @p irn
 360          *             can load it form memory internally
 361          * @return     nonzero if argument can be loaded or zero otherwise
 362          */
 363         int (*possible_memory_operand)(const ir_node *irn, unsigned int i);
 364
 365         /**
 366          * Ask the backend to assimilate @p reload of operand @p i into @p irn.
 367          *
 368          * @param irn    The node.
 369          * @param spill  The spill.
 370          * @param i      The position of the reload.
 371          */
 372         void (*perform_memory_operand)(ir_node *irn, ir_node *spill,
 373                                        unsigned int i);
 374 };
 375
 376 /**
 377  * Architecture interface.
 378  */
 379 struct arch_isa_if_t {
 380         /**
 381          * Initializes the isa interface. This is necessary before calling any
 382          * other functions from this interface.
 383          */
 384         void (*init)(void);
 385
 386         /**
 387          * Fress resources allocated by this isa interface.
 388          */
 389         void (*finish)(void);
 390
 391         /**
 392          * Returns the frontend settings needed for this backend.
 393          */
 394         const backend_params *(*get_params)(void);
 395
 396         /**
 397          * lowers current program for target. See the documentation for
 398          * be_lower_for_target() for details.
 399          */
 400         void (*lower_for_target)(void);
 401
 402         /**
 403          * parse an assembler constraint part and set flags according to its nature
 404          * advances the *c pointer to point to the last parsed character (so if you
 405          * parse a single character don't advance c)
 406          */
 407         asm_constraint_flags_t (*parse_asm_constraint)(const char **c);
 408
 409         /**
 410          * returns true if the string is a valid clobbered (register) in this
 411          * backend
 412          */
 413         int (*is_valid_clobber)(const char *clobber);
 414
 415         /**
 416          * Start codegeneration
 417          * @return a new isa instance
 418          */
 419         arch_env_t *(*begin_codegeneration)(const be_main_env_t *env);
 420
 421         /**
 422          * Free the isa instance.
 423          */
 424         void (*end_codegeneration)(void *self);
 425
 426         /**
 427          * Initialize the code generator for a graph
 428          * @param irg  A graph
 429          */
 430         void (*init_graph)(ir_graph *irg);
 431
 432         /**
 433          * Get the ABI restrictions for procedure calls.
 434          * @param call_type   The call type of the method (procedure) in question.
 435          * @param p           The array of parameter locations to be filled.
 436          */
 437         void (*get_call_abi)(ir_type *call_type, be_abi_call_t *abi);
 438
 439         /**
 440          * mark node as rematerialized
 441          */
 442         void (*mark_remat)(ir_node *node);
 443
 444         /**
 445          * return node used as base in pic code addresses
 446          */
 447         ir_node* (*get_pic_base)(ir_graph *irg);
 448
 449         /**
 450          * Create a spill instruction. We assume that spill instructions
 451          * do not need any additional registers and do not affect cpu-flags in any
 452          * way.
 453          * Construct a sequence of instructions after @p after (the resulting nodes
 454          * are already scheduled).
 455          * Returns a mode_M value which is used as input for a reload instruction.
 456          */
 457         ir_node *(*new_spill)(ir_node *value, ir_node *after);
 458
 459         /**
 460          * Create a reload instruction. We assume that reload instructions do not
 461          * need any additional registers and do not affect cpu-flags in any way.
 462          * Constructs a sequence of instruction before @p before (the resulting
 463          * nodes are already scheduled). A rewiring of users is not performed in
 464          * this function.
 465          * Returns a value representing the restored value.
 466          */
 467         ir_node *(*new_reload)(ir_node *value, ir_node *spilled_value,
 468                                ir_node *before);
 469
 470         /**
 471          * Checks if the given register is callee/caller saved.
 472          * @deprecated, only necessary if backend still uses beabi functions
 473          */
 474         int (*register_saved_by)(const arch_register_t *reg, int callee);
 475
 476         /**
 477          * Called directly after initialization. Backend should handle all
 478          * intrinsics here.
 479          */
 480         void (*handle_intrinsics)(void);
 481
 482         /**
 483          * Called before abi introduce.
 484          */
 485         void (*before_abi)(ir_graph *irg);
 486
 487         /**
 488          * Called, when the graph is being normalized.
 489          */
 490         void (*prepare_graph)(ir_graph *irg);
 491
 492         /**
 493          * Called before register allocation.
 494          */
 495         void (*before_ra)(ir_graph *irg);
 496
 497         /**
 498          * Called directly before done is called. This should be the last place
 499          * where the irg is modified.
 500          */
 501         void (*finish_graph)(ir_graph *irg);
 502
 503         /**
 504          * Called after everything happened. This call should emit the final
 505          * assembly code but avoid changing the irg.
 506          */
 507         void (*emit)(ir_graph *irg);
 508 };
 509
 510 #define arch_env_end_codegeneration(env)               ((env)->impl->end_codegeneration(env))
 511 #define arch_env_handle_intrinsics(env)                \
 512         do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
 513 #define arch_env_get_call_abi(env,tp,abi)              ((env)->impl->get_call_abi((tp), (abi)))
 514 #define arch_env_get_params(env)                       ((env)->impl->get_params())
 515 #define arch_env_parse_asm_constraint(env,c)           ((env)->impl->parse_asm_constraint((c))
 516 #define arch_env_is_valid_clobber(env,clobber)         ((env)->impl->is_valid_clobber((clobber))
 517 #define arch_env_mark_remat(env,node) \
 518         do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((node)); } while(0)
 519
 520 #define arch_env_new_spill(env,value,after)            ((env)->impl->new_spill(value, after))
 521 #define arch_env_new_reload(env,value,spilled,before)  ((env)->impl->new_reload(value, spilled, before))
 522
 523 /**
 524  * ISA base class.
 525  */
 526 struct arch_env_t {
 527         const arch_isa_if_t   *impl;
 528         unsigned               n_registers;      /**< number of registers */
 529         const arch_register_t *registers;        /**< register array */
 530         unsigned               n_register_classes; /**< number of register classes*/
 531         const arch_register_class_t *register_classes; /**< register classes */
 532         const arch_register_t *sp;               /**< The stack pointer register. */
 533         const arch_register_t *bp;               /**< The base pointer register. */
 534         int                    stack_alignment;  /**< power of 2 stack alignment */
 535         const be_main_env_t   *main_env;         /**< the be main environment */
 536         int                    spill_cost;       /**< cost for a be_Spill node */
 537         int                    reload_cost;      /**< cost for a be_Reload node */
 538         bool                   custom_abi : 1;   /**< backend does all abi handling
 539                                                       and does not need the generic
 540                                                       stuff from beabi.h/.c */
 541 };
 542
 543 static inline bool arch_irn_is_ignore(const ir_node *irn)
 544 {
 545         const arch_register_req_t *req = arch_get_irn_register_req(irn);
 546         return req->type & arch_register_req_type_ignore;
 547 }
 548
 549 static inline bool arch_irn_consider_in_reg_alloc(
 550                 const arch_register_class_t *cls, const ir_node *node)
 551 {
 552         const arch_register_req_t *req = arch_get_irn_register_req(node);
 553         return
 554                 req->cls == cls &&
 555                 !(req->type & arch_register_req_type_ignore);
 556 }
 557
 558 /**
 559  * Iterate over all values defined by an instruction.
 560  * Only looks at values in a certain register class where the requirements
 561  * are not marked as ignore.
 562  * Executes @p code for each definition.
 563  */
 564 #define be_foreach_definition_(node, ccls, value, code)                    \
 565         do {                                                                   \
 566         if (get_irn_mode(node) == mode_T) {                                    \
 567                 foreach_out_edge(node, edge_) {                                    \
 568                         ir_node                   *const value = get_edge_src_irn(edge_); \
 569                         arch_register_req_t const *const req_  = arch_get_irn_register_req(value); \
 570                         if (req_->cls != ccls)                                         \
 571                                 continue;                                                  \
 572                         code                                                           \
 573                 }                                                                  \
 574         } else {                                                               \
 575                 arch_register_req_t const *const req_  = arch_get_irn_register_req(node); \
 576                 ir_node                   *const value = node; \
 577                 if (req_->cls == ccls) {                                           \
 578                         code                                                           \
 579                 }                                                                  \
 580         }                                                                      \
 581         } while (0)
 582
 583 #define be_foreach_definition(node, ccls, value, code)                     \
 584         be_foreach_definition_(node, ccls, value,                              \
 585                 if (req_->type & arch_register_req_type_ignore)                    \
 586                         continue;                                                      \
 587                 code                                                               \
 588         )
 589
 590 static inline const arch_register_class_t *arch_get_irn_reg_class(
 591                 const ir_node *node)
 592 {
 593         const arch_register_req_t *req = arch_get_irn_register_req(node);
 594         return req->cls;
 595 }
 596
 597 bool arch_reg_is_allocatable(const arch_register_req_t *req,
 598                              const arch_register_t *reg);
 599
 600 #endif