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

   1 /*
   2  * Copyright (C) 1995-2008 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       Backend node support for generic backend nodes.
  23  * @author      Sebastian Hack
  24  * @date        17.05.2005
  25  * @version     $Id$
  26  *
  27  * Backend node support for generic backend nodes.
  28  * This file provides Perm, Copy, Spill and Reload nodes.
  29  */
  30 #ifndef FIRM_BE_BENODE_T_H
  31 #define FIRM_BE_BENODE_T_H
  32
  33 #include <limits.h>
  34
  35 #include "firm_types.h"
  36 #include "irnode.h"
  37 #include "bearch.h"
  38
  39 #define BE_OUT_POS(p) (-((p) + 1))
  40
  41 /**
  42  * The benode op's.  Must be available to register emitter function.
  43  */
  44 extern ir_op *op_be_Spill;
  45 extern ir_op *op_be_Reload;
  46 extern ir_op *op_be_Perm;
  47 extern ir_op *op_be_MemPerm;
  48 extern ir_op *op_be_Copy;
  49 extern ir_op *op_be_Keep;
  50 extern ir_op *op_be_CopyKeep;
  51 extern ir_op *op_be_Call;
  52 extern ir_op *op_be_Return;
  53 extern ir_op *op_be_IncSP;
  54 extern ir_op *op_be_AddSP;
  55 extern ir_op *op_be_SubSP;
  56 extern ir_op *op_be_RegParams;
  57 extern ir_op *op_be_FrameAddr;
  58 extern ir_op *op_be_Barrier;
  59 extern ir_op *op_be_Unwind;
  60
  61 typedef enum {
  62         beo_NoBeOp = -1,
  63         beo_Spill,
  64         beo_Reload,
  65         beo_Perm,
  66         beo_MemPerm,
  67         beo_Copy,
  68         beo_Keep,
  69         beo_CopyKeep,
  70         beo_Call,
  71         beo_Return,
  72         beo_AddSP,
  73         beo_SubSP,
  74         beo_IncSP,
  75         beo_RegParams,
  76         beo_FrameAddr,
  77         beo_Barrier,
  78         beo_Unwind,
  79         beo_Last
  80 } be_opcode_t;
  81
  82 /** Not used yet. */
  83 typedef enum {
  84         be_frame_flag_spill = 1,
  85         be_frame_flag_local = 2,
  86         be_frame_flag_arg   = 4
  87 } be_frame_flag_t;
  88
  89 /**
  90  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
  91  * It gets back-patched to the real size as soon it is known.
  92  */
  93 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
  94 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
  95
  96 /**
  97  * Determines if irn is a be_node.
  98  */
  99 int is_be_node(const ir_node *irn);
 100
 101 /**
 102  * Create all BE specific opcodes.
 103  */
 104 void be_node_init(void);
 105
 106 /**
 107  * Position numbers for the be_Spill inputs.
 108  */
 109 enum {
 110         be_pos_Spill_frame = 0,
 111         be_pos_Spill_val   = 1
 112 };
 113
 114 /**
 115  * Make a new Spill node.
 116  */
 117 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
 118         ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
 119
 120 /**
 121  * Position numbers for the be_Reload inputs.
 122  */
 123 enum {
 124         be_pos_Reload_frame = 0,
 125         be_pos_Reload_mem   = 1
 126 };
 127
 128 /**
 129  * Make a new Reload node.
 130  */
 131 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
 132         ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
 133
 134 /**
 135  * Position numbers for the be_Copy inputs.
 136  */
 137 enum {
 138         be_pos_Copy_op = 0
 139 };
 140
 141 /**
 142  * Make a new Copy node.
 143  */
 144 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
 145 /** Returns the Copy Argument. */
 146 ir_node *be_get_Copy_op(const ir_node *cpy);
 147 /** Sets the Copy Argument. */
 148 void be_set_Copy_op(ir_node *cpy, ir_node *op);
 149
 150 /**
 151  * Make a new Perm node.
 152  */
 153 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 154
 155 /**
 156  * Reduce a Perm.
 157  * Basically, we provide a map to remap the Perm's arguments. If an entry in the
 158  * map is -1, the argument gets deleted.
 159  * This function takes care, that the register data and the input array reflects
 160  * the changes described by the map.
 161  * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
 162  * @param perm     The perm node.
 163  * @param new_size The new number of arguments (must be smaller or equal to the current one).
 164  * @param map      A map assigning each operand a new index (or -1 to indicate deletion).
 165  */
 166 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
 167
 168 /**
 169  * Create a new MemPerm node.
 170  */
 171 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 172 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 173
 174 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
 175
 176 /**
 177  * Position numbers for the be_FrameAddr inputs
 178  */
 179 enum {
 180         be_pos_FrameAddr_ptr = 0
 181 };
 182
 183 /** Create a new FrameAddr node. */
 184 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
 185
 186 /** Return the frame input of a FrameAddr node. */
 187 ir_node *be_get_FrameAddr_frame(const ir_node *node);
 188
 189 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
 190
 191 /**
 192  * Position numbers for the be_AddSP inputs
 193  */
 194 enum {
 195         be_pos_AddSP_old_sp = 0,
 196         be_pos_AddSP_size   = 1,
 197         be_pos_AddSP_last   = 2
 198 };
 199
 200 enum {
 201         pn_be_AddSP_sp   = 0,
 202         pn_be_AddSP_res  = 1,
 203         pn_be_AddSP_M    = 2,
 204         pn_be_AddSP_last = 3
 205 };
 206
 207 /**
 208  * Make a new AddSP node.
 209  * An AddSP node expresses an increase of the stack pointer in the direction the stack
 210  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
 211  * given by a constant but an ordinary Firm node.
 212  * @param sp     The stack pointer register.
 213  * @param irg    The graph.
 214  * @param bl     The block.
 215  * @param old_sp The node representing the old stack pointer value.
 216  * @param sz     The node expressing the size by which the stack pointer shall be grown.
 217  * @return       A new AddSP node.
 218  */
 219 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
 220
 221 /**
 222  * Position numbers for the be_SubSP inputs
 223  */
 224 enum {
 225         be_pos_SubSP_old_sp = 0,
 226         be_pos_SubSP_size   = 1,
 227         be_pos_SubSP_last   = 2
 228 };
 229
 230 enum {
 231         pn_be_SubSP_sp   = 0,
 232         pn_be_SubSP_M    = 1,
 233         pn_be_SubSP_last = 2
 234 };
 235
 236 /**
 237  * Make a new SubSP node.
 238  * A SubSP node expresses a decrease of the stack pointer in the direction the stack
 239  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
 240  * given by a constant but an ordinary Firm node.
 241  * @param sp     The stack pointer register.
 242  * @param irg    The graph.
 243  * @param bl     The block.
 244  * @param old_sp The node representing the old stack pointer value.
 245  * @param sz     The node expressing the size by which the stack pointer shall be grown.
 246  * @return       A new DecSP node.
 247  */
 248 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
 249
 250 /**
 251  * Make a stack pointer increase/decrease node.
 252  * @param sp     The stack pointer register.
 253  * @param irg    The graph to insert the node to.
 254  * @param bl     The block to insert the node into.
 255  * @param old_sp The node defining the former stack pointer.
 256  * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
 257  * @param dir    The direction in which the stack pointer shall be modified:
 258  *               Along the stack's growing direction or against.
 259  * @return       A new stack pointer increment/decrement node.
 260  * @note         This node sets a register constraint to the @p sp register on its output.
 261  */
 262 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl,
 263                       ir_node *old_sp, int offset, int align);
 264
 265 /** Returns the previous node that computes the stack pointer. */
 266 ir_node *be_get_IncSP_pred(ir_node *incsp);
 267
 268 /** Sets the previous node that computes the stack pointer. */
 269 void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
 270
 271 /**
 272  * Sets a new offset to a IncSP node.
 273  * A positive offset means expanding the stack, a negative offset shrinking
 274  * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
 275  * stackframe in the fix_stack_offsets phase.
 276  */
 277 void     be_set_IncSP_offset(ir_node *irn, int offset);
 278
 279 /** Gets the offset from a IncSP node. */
 280 int be_get_IncSP_offset(const ir_node *irn);
 281 int be_get_IncSP_align(const ir_node *irn);
 282
 283 /** Gets the call entity or NULL if this is no static call. */
 284 ir_entity  *be_Call_get_entity(const ir_node *call);
 285 /** Sets the call entity. */
 286 void     be_Call_set_entity(ir_node *call, ir_entity *ent);
 287 /** Gets the call type. */
 288 ir_type *be_Call_get_type(ir_node *call);
 289 /** Sets the call type. */
 290 void     be_Call_set_type(ir_node *call, ir_type *call_tp);
 291
 292 void     be_Call_set_pop(ir_node *call, unsigned pop);
 293
 294 unsigned be_Call_get_pop(const ir_node *call);
 295
 296 /**
 297  * Position numbers for the be_Call inputs.
 298  */
 299 enum {
 300         be_pos_Call_mem       = 0,  /**< memory input of a be_Call node */
 301         be_pos_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
 302         be_pos_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
 303         be_pos_Call_first_arg = 3   /**< first argument input of a be_Call node */
 304 };
 305
 306 /**
 307  * Projection numbers for result of be_Call node: use for Proj nodes!
 308  */
 309 typedef enum {
 310         pn_be_Call_M_regular = pn_Call_M_regular,  /**< The memory result of a be_Call. */
 311         pn_be_Call_sp        = pn_Call_max,
 312         pn_be_Call_first_res                      /**< The first result proj number of a be_Call. */
 313 } pn_be_Call;
 314
 315 /**
 316  * Construct a new be_Call.
 317  *
 318  * @param dbg      debug info
 319  * @param irg      the graph where the call is placed
 320  * @param bl       the block where the call is placed
 321  * @param mem      the memory input of the call
 322  * @param sp       the stack pointer input of the call
 323  * @param ptr      the address of the called function, if immediate call set to sp
 324  * @param n_outs   the number of outcoming values from this call
 325  * @param n        the number of (register) inputs of this call
 326  * @param in       the (register) inputs of this call
 327  * @param call_tp  the call type of this call
 328  */
 329 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
 330                      int n_outs, int n, ir_node *in[], ir_type *call_tp);
 331
 332 /**
 333  * Position numbers for the be_Return inputs.
 334  */
 335 enum {
 336         be_pos_Return_mem  = 0,     /**< memory input of a be_Return node */
 337         be_pos_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
 338         be_pos_Return_val  = 2,     /**< first "real" return value if any */
 339 };
 340
 341 /**
 342  * Construct a new be_Return.
 343  *
 344  * @param dbg    debug info
 345  * @param irg    the graph where the new node will be placed
 346  * @param bl     the block where the new node will be placed
 347  * @param n_res  number of "real" results
 348  * @param n      number of inputs
 349  * @param pop    pop number of bytes on return
 350  * @param in     input array
 351  */
 352 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, unsigned pop, int n, ir_node *in[]);
 353
 354 /** Returns the number of real returns values */
 355 int be_Return_get_n_rets(const ir_node *ret);
 356
 357 /**
 358  * Return the number of bytes that should be popped from stack when executing the Return.
 359  *
 360  * @param ret  the be_Return node
 361  */
 362 unsigned be_Return_get_pop(const ir_node *ret);
 363
 364 /**
 365  * Return non-zero, if number of popped bytes must be always emitted.
 366  *
 367  * @param ret  the be_Return node
 368  */
 369 int be_Return_get_emit_pop(const ir_node *ret);
 370
 371 /**
 372  * Set the emit_pop flag.
 373  *
 374  * @param ret  the be_Return node
 375  */
 376 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
 377
 378 /** appends a node to the return node, returns the position of the node */
 379 int be_Return_append_node(ir_node *ret, ir_node *node);
 380
 381 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
 382
 383 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 384
 385 /**
 386  * Appends a node to a barrier, returns the result proj of the node
 387  */
 388 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
 389
 390 /**
 391  * Appends a register out requirement to a RegParams node
 392  *
 393  * @returns the proj node for the new register
 394  */
 395 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
 396                                      const arch_env_t *arch_env,
 397                                      const arch_register_t *reg);
 398
 399 /**
 400  * Make a spill node.
 401  *
 402  * @param arch_env  The architecture environment.
 403  * @param irn       The node to be spilled.
 404  * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
 405  * @return          The new spill node.
 406  */
 407 ir_node *be_spill(const arch_env_t *arch_env, ir_node *block, ir_node *irn);
 408
 409 /**
 410  * Make a reload and insert it into the schedule.
 411  *
 412  * @param arch_env The architecture environment.
 413  * @param cls      The register class of the reloaded value.
 414  * @param insert   The node in the schedule in front of which the reload is inserted.
 415  * @param mode     The mode of the original (spilled) value.
 416  * @param spill    The spill node corresponding to this reload.
 417  * @return         A freshly made reload.
 418  */
 419 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
 420
 421 enum {
 422         be_pos_CopyKeep_op = 0
 423 };
 424 ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, int n, ir_node *in_keep[], ir_mode *mode);
 425 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);
 426 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
 427 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 428
 429 /**
 430  * Position numbers for the be_Unwind inputs.
 431  */
 432 enum {
 433         be_pos_Unwind_mem  = 0,     /**< memory input of a be_Unwind node */
 434         be_pos_Unwind_sp   = 1,     /**< stack pointer input of a be_Unwind node */
 435 };
 436
 437 /**
 438  * Construct a new be_Unwind.
 439  *
 440  * @param dbg    debug info
 441  * @param irg    the graph where the new node will be placed
 442  * @param bl     the block where the new node will be placed
 443  * @param mem    the memory input
 444  * @param sp     the stack pointer input
 445  */
 446 ir_node *be_new_Unwind(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp);
 447
 448 ir_node *be_get_Unwind_mem(const ir_node *irn);
 449 ir_node *be_get_Unwind_sp(const ir_node *irn);
 450
 451 /**
 452  * Get the backend opcode of a backend node.
 453  * @param irn The node.
 454  * @return The backend opcode.
 455  */
 456 be_opcode_t be_get_irn_opcode(const ir_node *irn);
 457
 458 int be_is_Spill(const ir_node *irn);
 459 int be_is_Reload(const ir_node *irn);
 460 int be_is_Copy(const ir_node *irn);
 461 int be_is_Perm(const ir_node *irn);
 462 int be_is_MemPerm(const ir_node *irn);
 463 int be_is_Keep(const ir_node *irn);
 464 int be_is_CopyKeep(const ir_node *irn);
 465 int be_is_Call(const ir_node *irn);
 466 int be_is_Return(const ir_node *irn);
 467 int be_is_IncSP(const ir_node *irn);
 468 int be_is_AddSP(const ir_node *irn);
 469 int be_is_SubSP(const ir_node *irn);
 470 int be_is_RegParams(const ir_node *irn);
 471 int be_is_FrameAddr(const ir_node *irn);
 472 int be_is_Barrier(const ir_node *irn);
 473 int be_is_Unwind(const ir_node *irn);
 474
 475 /**
 476  * Returns the frame entity of a be node.
 477  * Try to avoid this function and better call arch_get_frame_entity!
 478  *
 479  * @return the frame entity used by the be node
 480  */
 481 ir_entity *be_get_frame_entity(const ir_node *irn);
 482
 483 /**
 484  * Returns the frame offset of this node.
 485  */
 486 int be_get_frame_offset(const ir_node *irn);
 487
 488 ir_node* be_get_Reload_mem(const ir_node *irn);
 489 ir_node *be_get_Reload_frame(const ir_node *irn);
 490 ir_node* be_get_Spill_val(const ir_node *irn);
 491 ir_node *be_get_Spill_frame(const ir_node *irn);
 492
 493 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
 494 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
 495
 496 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
 497 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
 498
 499 int be_get_MemPerm_entity_arity(const ir_node *irn);
 500
 501 /**
 502  * Impose a register constraint on a backend node.
 503  * @param irn The node.
 504  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
 505  * @param reg The register which is admissible for that node, argument/result and position.
 506  */
 507 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
 508
 509 /**
 510  * Impose register constraints on a backend node.
 511  * The register subsets given by the limited function in @p req are copied to the backend node.
 512  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
 513  * @param irn The backend node.
 514  * @param pos The position (@see be_set_constr_single_reg()).
 515  * @param req The register requirements which shall be transferred.
 516  */
 517 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
 518
 519 /**
 520  * Set the flags of a node.
 521  * @param irn The node itself.
 522  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 523  * @param flags The flags to set for that node and position.
 524  */
 525 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
 526
 527 void be_node_add_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
 528
 529 /**
 530  * Set the register class of a node.
 531  * @param irn The node itself.
 532  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 533  * @param flags The register class to set for that node and position.
 534  */
 535 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
 536
 537 /**
 538  * Set the register requirement type of a node.
 539  * @param irn The node itself.
 540  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 541  * @param flags The register requirement type to set for that node and position.
 542  */
 543 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
 544
 545 /**
 546  * Make a new phi handler.
 547  * @param env The architecture environment.
 548  * @return A new phi handler.
 549  */
 550 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
 551
 552 /**
 553  * Free a phi handler.
 554  * @param handler The handler to free.
 555  */
 556 void be_phi_handler_free(arch_irn_handler_t *handler);
 557
 558 /**
 559  * Reset the register data in the phi handler.
 560  * This should be called on each new graph and deletes the register information of the current graph.
 561  */
 562 void be_phi_handler_reset(arch_irn_handler_t *handler);
 563
 564 /**
 565  * Set the register requirements for a phi node.
 566  */
 567 void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
 568                         const arch_register_req_t *req);
 569
 570 /*
 571  * Set flags for a phi node
 572  */
 573 void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
 574                       arch_irn_flags_t flags);
 575
 576 /**
 577  * irn handler for common be nodes.
 578  */
 579 extern const arch_irn_handler_t be_node_irn_handler;
 580
 581 #endif /* FIRM_BE_BENODE_T_H */