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 void arch_dump_register_reqs(FILE *F, const ir_node *node);
  96 void arch_dump_reqs_and_registers(FILE *F, const ir_node *node);
  97
  98 void arch_set_frame_offset(ir_node *irn, int bias);
  99
 100 ir_entity *arch_get_frame_entity(const ir_node *irn);
 101 int        arch_get_sp_bias(ir_node *irn);
 102
 103 int             arch_get_op_estimated_cost(const ir_node *irn);
 104 int             arch_possible_memory_operand(const ir_node *irn,
 105                                              unsigned int i);
 106 void            arch_perform_memory_operand(ir_node *irn, ir_node *spill,
 107                                             unsigned int i);
 108
 109 /**
 110  * Get the register allocated for a value.
 111  */
 112 const arch_register_t *arch_get_irn_register(const ir_node *irn);
 113
 114 /**
 115  * Assign register to a value
 116  */
 117 void arch_set_irn_register(ir_node *irn, const arch_register_t *reg);
 118
 119 /**
 120  * Set the register for a certain output operand.
 121  */
 122 void arch_set_irn_register_out(ir_node *irn, unsigned pos, const arch_register_t *r);
 123
 124 const arch_register_t *arch_get_irn_register_out(const ir_node *irn, unsigned pos);
 125 const arch_register_t *arch_get_irn_register_in(const ir_node *irn, int pos);
 126
 127 /**
 128  * Get register constraints for an operand at position @p
 129  */
 130 static inline const arch_register_req_t *arch_get_irn_register_req_in(
 131                 const ir_node *node, int pos)
 132 {
 133         const backend_info_t *info = be_get_info(node);
 134         return info->in_reqs[pos];
 135 }
 136
 137 /**
 138  * Get register constraint for a produced result (the @p pos result)
 139  */
 140 static inline const arch_register_req_t *arch_get_irn_register_req_out(
 141                 const ir_node *node, unsigned pos)
 142 {
 143         const backend_info_t *info = be_get_info(node);
 144         return info->out_infos[pos].req;
 145 }
 146
 147 static inline void arch_set_irn_register_req_out(ir_node *node, unsigned pos,
 148                 const arch_register_req_t *req)
 149 {
 150         backend_info_t *info = be_get_info(node);
 151         assert(pos < (unsigned)ARR_LEN(info->out_infos));
 152         info->out_infos[pos].req = req;
 153 }
 154
 155 static inline void arch_set_irn_register_reqs_in(ir_node *node,
 156                 const arch_register_req_t **reqs)
 157 {
 158         backend_info_t *info = be_get_info(node);
 159         info->in_reqs = reqs;
 160 }
 161
 162 static inline const arch_register_req_t **arch_get_irn_register_reqs_in(
 163                 const ir_node *node)
 164 {
 165         backend_info_t *info = be_get_info(node);
 166         return info->in_reqs;
 167 }
 168
 169 static inline reg_out_info_t *get_out_info(const ir_node *node)
 170 {
 171         size_t                pos = 0;
 172         const backend_info_t *info;
 173         assert(get_irn_mode(node) != mode_T);
 174         if (is_Proj(node)) {
 175                 pos  = get_Proj_proj(node);
 176                 node = get_Proj_pred(node);
 177         }
 178
 179         info = be_get_info(node);
 180         assert(pos < ARR_LEN(info->out_infos));
 181         return &info->out_infos[pos];
 182 }
 183
 184 static inline const arch_register_req_t *arch_get_irn_register_req(const ir_node *node)
 185 {
 186         reg_out_info_t *out = get_out_info(node);
 187         return out->req;
 188 }
 189
 190 /**
 191  * Get the flags of a node.
 192  * @param irn The node.
 193  * @return The flags.
 194  */
 195 static inline arch_irn_flags_t arch_get_irn_flags(const ir_node *node)
 196 {
 197         backend_info_t const *const info = be_get_info(node);
 198         return info->flags;
 199 }
 200
 201 void arch_set_irn_flags(ir_node *node, arch_irn_flags_t flags);
 202 void arch_add_irn_flags(ir_node *node, arch_irn_flags_t flags);
 203
 204 #define arch_irn_is(irn, flag) ((arch_get_irn_flags(irn) & arch_irn_flags_ ## flag) != 0)
 205
 206 static inline unsigned arch_get_irn_n_outs(const ir_node *node)
 207 {
 208         backend_info_t *info = be_get_info(node);
 209         if (info->out_infos == NULL)
 210                 return 0;
 211
 212         return (unsigned)ARR_LEN(info->out_infos);
 213 }
 214
 215 /**
 216  * Start codegeneration
 217  */
 218 arch_env_t *arch_env_begin_codegeneration(const arch_isa_if_t *isa,
 219                                           be_main_env_t *main_env);
 220
 221 /**
 222  * Register an instruction set architecture
 223  */
 224 void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
 225
 226 /**
 227  * A register.
 228  */
 229 struct arch_register_t {
 230         const char                  *name;         /**< The name of the register. */
 231         const arch_register_class_t *reg_class;    /**< The class of the register */
 232         unsigned short               index;        /**< The index of the register in
 233                                                         the class. */
 234         unsigned short               global_index; /**< The global index this
 235                                                                                                     register in the architecture. */
 236         arch_register_type_t         type;         /**< The type of the register. */
 237         /** register constraint allowing just this register */
 238         const arch_register_req_t   *single_req;
 239         /** register number in dwarf debugging format */
 240         unsigned short               dwarf_number;
 241 };
 242
 243 /**
 244  * A class of registers.
 245  * Like general purpose or floating point.
 246  */
 247 struct arch_register_class_t {
 248         unsigned                     index;   /**< index of this register class */
 249         const char                  *name;    /**< The name of the register class.*/
 250         unsigned                     n_regs;  /**< Number of registers in this
 251                                                    class. */
 252         ir_mode                     *mode;    /**< The mode of the register class.*/
 253         const arch_register_t       *regs;    /**< The array of registers. */
 254         arch_register_class_flags_t  flags;   /**< register class flags. */
 255         const arch_register_req_t   *class_req;
 256 };
 257
 258 /** return the number of registers in this register class */
 259 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
 260
 261 /** return the largest mode of this register class */
 262 #define arch_register_class_mode(cls) ((cls)->mode)
 263
 264 /** return the name of this register class */
 265 #define arch_register_class_name(cls) ((cls)->name)
 266
 267 /** return the index of this register class */
 268 #define arch_register_class_index(cls)  ((cls)->index)
 269
 270 /** return the register class flags */
 271 #define arch_register_class_flags(cls) ((cls)->flags)
 272
 273 static inline const arch_register_t *arch_register_for_index(
 274                 const arch_register_class_t *cls, unsigned idx)
 275 {
 276         assert(idx < cls->n_regs);
 277         return &cls->regs[idx];
 278 }
 279
 280 /**
 281  * Convenience macro to check for set constraints.
 282  * @param req   A pointer to register requirements.
 283  * @param kind  The kind of constraint to check for
 284  *              (see arch_register_req_type_t).
 285  * @return      1, If the kind of constraint is present, 0 if not.
 286  */
 287 #define arch_register_req_is(req, kind) \
 288         (((req)->type & (arch_register_req_type_ ## kind)) != 0)
 289
 290 /**
 291  * Expresses requirements to register allocation for an operand.
 292  */
 293 struct arch_register_req_t {
 294         arch_register_req_type_t     type; /**< The type of the constraint. */
 295         const arch_register_class_t *cls;  /**< The register class this constraint
 296                                                 belongs to. */
 297         const unsigned *limited;           /**< allowed register bitset
 298                                                 (in case of wide-values this is
 299                                                  only about the first register) */
 300         unsigned other_same;               /**< Bitmask of ins which should use the
 301                                                 same register (should_be_same). */
 302         unsigned other_different;          /**< Bitmask of ins which shall use a
 303                                                 different register
 304                                                 (must_be_different) */
 305         unsigned char width;               /**< specifies how many sequential
 306                                                 registers are required */
 307 };
 308
 309 static inline bool reg_reqs_equal(const arch_register_req_t *req1,
 310                                   const arch_register_req_t *req2)
 311 {
 312         if (req1 == req2)
 313                 return true;
 314
 315         if (req1->type              != req2->type            ||
 316             req1->cls               != req2->cls             ||
 317             req1->other_same        != req2->other_same      ||
 318             req1->other_different   != req2->other_different ||
 319             (req1->limited != NULL) != (req2->limited != NULL))
 320                 return false;
 321
 322         if (req1->limited != NULL) {
 323                 size_t const n_regs = arch_register_class_n_regs(req1->cls);
 324                 if (!rbitsets_equal(req1->limited, req2->limited, n_regs))
 325                         return false;
 326         }
 327
 328         return true;
 329 }
 330
 331 struct arch_irn_ops_t {
 332
 333         /**
 334          * Get the entity on the stack frame this node depends on.
 335          * @param irn  The node in question.
 336          * @return The entity on the stack frame or NULL, if the node does not have
 337          *         a stack frame entity.
 338          */
 339         ir_entity *(*get_frame_entity)(const ir_node *irn);
 340
 341         /**
 342          * Set the offset of a node carrying an entity on the stack frame.
 343          * @param irn  The node.
 344          * @param offset The offset of the node's stack frame entity.
 345          */
 346         void (*set_frame_offset)(ir_node *irn, int offset);
 347
 348         /**
 349          * Returns the delta of the stackpointer for nodes that increment or
 350          * decrement the stackpointer with a constant value. (push, pop
 351          * nodes on most architectures).
 352          * A positive value stands for an expanding stack area, a negative value for
 353          * a shrinking one.
 354          *
 355          * @param irn       The node
 356          * @return          0 if the stackpointer is not modified with a constant
 357          *                  value, otherwise the increment/decrement value
 358          */
 359         int (*get_sp_bias)(const ir_node *irn);
 360
 361         /**
 362          * Get the estimated cycle count for @p irn.
 363          *
 364          * @param irn  The node.
 365          * @return     The estimated cycle count for this operation
 366          */
 367         int (*get_op_estimated_cost)(const ir_node *irn);
 368
 369         /**
 370          * Asks the backend whether operand @p i of @p irn can be loaded form memory
 371          * internally
 372          *
 373          * @param irn  The node.
 374          * @param i    Index of the argument we would like to know whether @p irn
 375          *             can load it form memory internally
 376          * @return     nonzero if argument can be loaded or zero otherwise
 377          */
 378         int (*possible_memory_operand)(const ir_node *irn, unsigned int i);
 379
 380         /**
 381          * Ask the backend to assimilate @p reload of operand @p i into @p irn.
 382          *
 383          * @param irn    The node.
 384          * @param spill  The spill.
 385          * @param i      The position of the reload.
 386          */
 387         void (*perform_memory_operand)(ir_node *irn, ir_node *spill,
 388                                        unsigned int i);
 389 };
 390
 391 /**
 392  * Architecture interface.
 393  */
 394 struct arch_isa_if_t {
 395         /**
 396          * Initializes the isa interface. This is necessary before calling any
 397          * other functions from this interface.
 398          */
 399         void (*init)(void);
 400
 401         /**
 402          * Fress resources allocated by this isa interface.
 403          */
 404         void (*finish)(void);
 405
 406         /**
 407          * Returns the frontend settings needed for this backend.
 408          */
 409         const backend_params *(*get_params)(void);
 410
 411         /**
 412          * lowers current program for target. See the documentation for
 413          * be_lower_for_target() for details.
 414          */
 415         void (*lower_for_target)(void);
 416
 417         /**
 418          * parse an assembler constraint part and set flags according to its nature
 419          * advances the *c pointer to point to the last parsed character (so if you
 420          * parse a single character don't advance c)
 421          */
 422         asm_constraint_flags_t (*parse_asm_constraint)(const char **c);
 423
 424         /**
 425          * returns true if the string is a valid clobbered (register) in this
 426          * backend
 427          */
 428         int (*is_valid_clobber)(const char *clobber);
 429
 430         /**
 431          * Start codegeneration
 432          * @return a new isa instance
 433          */
 434         arch_env_t *(*begin_codegeneration)(const be_main_env_t *env);
 435
 436         /**
 437          * Free the isa instance.
 438          */
 439         void (*end_codegeneration)(void *self);
 440
 441         /**
 442          * Initialize the code generator for a graph
 443          * @param irg  A graph
 444          */
 445         void (*init_graph)(ir_graph *irg);
 446
 447         /**
 448          * Get the ABI restrictions for procedure calls.
 449          * @param call_type   The call type of the method (procedure) in question.
 450          * @param p           The array of parameter locations to be filled.
 451          */
 452         void (*get_call_abi)(ir_type *call_type, be_abi_call_t *abi);
 453
 454         /**
 455          * mark node as rematerialized
 456          */
 457         void (*mark_remat)(ir_node *node);
 458
 459         /**
 460          * return node used as base in pic code addresses
 461          */
 462         ir_node* (*get_pic_base)(ir_graph *irg);
 463
 464         /**
 465          * Create a spill instruction. We assume that spill instructions
 466          * do not need any additional registers and do not affect cpu-flags in any
 467          * way.
 468          * Construct a sequence of instructions after @p after (the resulting nodes
 469          * are already scheduled).
 470          * Returns a mode_M value which is used as input for a reload instruction.
 471          */
 472         ir_node *(*new_spill)(ir_node *value, ir_node *after);
 473
 474         /**
 475          * Create a reload instruction. We assume that reload instructions do not
 476          * need any additional registers and do not affect cpu-flags in any way.
 477          * Constructs a sequence of instruction before @p before (the resulting
 478          * nodes are already scheduled). A rewiring of users is not performed in
 479          * this function.
 480          * Returns a value representing the restored value.
 481          */
 482         ir_node *(*new_reload)(ir_node *value, ir_node *spilled_value,
 483                                ir_node *before);
 484
 485         /**
 486          * Checks if the given register is callee/caller saved.
 487          * @deprecated, only necessary if backend still uses beabi functions
 488          */
 489         int (*register_saved_by)(const arch_register_t *reg, int callee);
 490
 491         /**
 492          * Called directly after initialization. Backend should handle all
 493          * intrinsics here.
 494          */
 495         void (*handle_intrinsics)(void);
 496
 497         /**
 498          * Called before abi introduce.
 499          */
 500         void (*before_abi)(ir_graph *irg);
 501
 502         /**
 503          * Called, when the graph is being normalized.
 504          */
 505         void (*prepare_graph)(ir_graph *irg);
 506
 507         /**
 508          * Called before register allocation.
 509          */
 510         void (*before_ra)(ir_graph *irg);
 511
 512         /**
 513          * Called directly before done is called. This should be the last place
 514          * where the irg is modified.
 515          */
 516         void (*finish_graph)(ir_graph *irg);
 517
 518         /**
 519          * Called after everything happened. This call should emit the final
 520          * assembly code but avoid changing the irg.
 521          */
 522         void (*emit)(ir_graph *irg);
 523 };
 524
 525 #define arch_env_end_codegeneration(env)               ((env)->impl->end_codegeneration(env))
 526 #define arch_env_handle_intrinsics(env)                \
 527         do { if((env)->impl->handle_intrinsics != NULL) (env)->impl->handle_intrinsics(); } while(0)
 528 #define arch_env_get_call_abi(env,tp,abi)              ((env)->impl->get_call_abi((tp), (abi)))
 529 #define arch_env_get_params(env)                       ((env)->impl->get_params())
 530 #define arch_env_parse_asm_constraint(env,c)           ((env)->impl->parse_asm_constraint((c))
 531 #define arch_env_is_valid_clobber(env,clobber)         ((env)->impl->is_valid_clobber((clobber))
 532 #define arch_env_mark_remat(env,node) \
 533         do { if ((env)->impl->mark_remat != NULL) (env)->impl->mark_remat((node)); } while(0)
 534
 535 #define arch_env_new_spill(env,value,after)            ((env)->impl->new_spill(value, after))
 536 #define arch_env_new_reload(env,value,spilled,before)  ((env)->impl->new_reload(value, spilled, before))
 537
 538 /**
 539  * ISA base class.
 540  */
 541 struct arch_env_t {
 542         const arch_isa_if_t   *impl;
 543         unsigned               n_registers;      /**< number of registers */
 544         const arch_register_t *registers;        /**< register array */
 545         unsigned               n_register_classes; /**< number of register classes*/
 546         const arch_register_class_t *register_classes; /**< register classes */
 547         const arch_register_t *sp;               /**< The stack pointer register. */
 548         const arch_register_t *bp;               /**< The base pointer register. */
 549         int                    stack_alignment;  /**< power of 2 stack alignment */
 550         const be_main_env_t   *main_env;         /**< the be main environment */
 551         int                    spill_cost;       /**< cost for a be_Spill node */
 552         int                    reload_cost;      /**< cost for a be_Reload node */
 553         bool                   custom_abi : 1;   /**< backend does all abi handling
 554                                                       and does not need the generic
 555                                                       stuff from beabi.h/.c */
 556 };
 557
 558 static inline bool arch_irn_is_ignore(const ir_node *irn)
 559 {
 560         const arch_register_req_t *req = arch_get_irn_register_req(irn);
 561         return arch_register_req_is(req, ignore);
 562 }
 563
 564 static inline bool arch_irn_consider_in_reg_alloc(
 565                 const arch_register_class_t *cls, const ir_node *node)
 566 {
 567         const arch_register_req_t *req = arch_get_irn_register_req(node);
 568         return req->cls == cls && !arch_register_req_is(req, ignore);
 569 }
 570
 571 /**
 572  * Iterate over all values defined by an instruction.
 573  * Only looks at values in a certain register class where the requirements
 574  * are not marked as ignore.
 575  * Executes @p code for each definition.
 576  */
 577 #define be_foreach_definition_(node, ccls, value, code)                    \
 578         do {                                                                   \
 579         if (get_irn_mode(node) == mode_T) {                                    \
 580                 foreach_out_edge(node, edge_) {                                    \
 581                         ir_node                   *const value = get_edge_src_irn(edge_); \
 582                         arch_register_req_t const *const req_  = arch_get_irn_register_req(value); \
 583                         if (req_->cls != ccls)                                         \
 584                                 continue;                                                  \
 585                         code                                                           \
 586                 }                                                                  \
 587         } else {                                                               \
 588                 arch_register_req_t const *const req_  = arch_get_irn_register_req(node); \
 589                 ir_node                   *const value = node; \
 590                 if (req_->cls == ccls) {                                           \
 591                         code                                                           \
 592                 }                                                                  \
 593         }                                                                      \
 594         } while (0)
 595
 596 #define be_foreach_definition(node, ccls, value, code) \
 597         be_foreach_definition_(node, ccls, value, \
 598                 if (arch_register_req_is(req_, ignore)) \
 599                         continue; \
 600                 code \
 601         )
 602
 603 static inline const arch_register_class_t *arch_get_irn_reg_class(
 604                 const ir_node *node)
 605 {
 606         const arch_register_req_t *req = arch_get_irn_register_req(node);
 607         return req->cls;
 608 }
 609
 610 bool arch_reg_is_allocatable(const arch_register_req_t *req,
 611                              const arch_register_t *reg);
 612
 613 #endif