nsz Git - libfirm/blob - ir/be/benode.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_t.h"
  37 #include "bearch.h"
  38
  39 /**
  40  * The benode op's.  Must be available to register emitter function.
  41  */
  42 extern ir_op *op_be_Spill;
  43 extern ir_op *op_be_Reload;
  44 extern ir_op *op_be_Perm;
  45 extern ir_op *op_be_MemPerm;
  46 extern ir_op *op_be_Copy;
  47 extern ir_op *op_be_Keep;
  48 extern ir_op *op_be_CopyKeep;
  49 extern ir_op *op_be_Call;
  50 extern ir_op *op_be_Return;
  51 extern ir_op *op_be_IncSP;
  52 extern ir_op *op_be_AddSP;
  53 extern ir_op *op_be_SubSP;
  54 extern ir_op *op_be_Start;
  55 extern ir_op *op_be_FrameAddr;
  56
  57 /**
  58  * Determines if irn is a be_node.
  59  */
  60 int is_be_node(const ir_node *irn);
  61
  62 /**
  63  * Create all BE specific opcodes.
  64  */
  65 void be_init_op(void);
  66
  67 /**
  68  * Position numbers for the be_Spill inputs.
  69  */
  70 enum {
  71         n_be_Spill_frame = 0,
  72         n_be_Spill_val   = 1
  73 };
  74
  75 /**
  76  * Make a new Spill node.
  77  */
  78 ir_node *be_new_Spill(const arch_register_class_t *cls,
  79                       const arch_register_class_t *cls_frame, ir_node *block,
  80                       ir_node *frame, ir_node *to_spill);
  81
  82 /**
  83  * Position numbers for the be_Reload inputs.
  84  */
  85 enum {
  86         n_be_Reload_frame = 0,
  87         n_be_Reload_mem   = 1
  88 };
  89
  90 /**
  91  * Make a new Reload node.
  92  */
  93 ir_node *be_new_Reload(const arch_register_class_t *cls,
  94                        const arch_register_class_t *cls_frame, ir_node *block,
  95                        ir_node *frame, ir_node *mem, ir_mode *mode);
  96
  97 /**
  98  * Position numbers for the be_Copy inputs.
  99  */
 100 enum {
 101         n_be_Copy_op = 0
 102 };
 103
 104 /**
 105  * Make a new Copy node.
 106  */
 107 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block,
 108                      ir_node *in);
 109 /** Returns the Copy Argument. */
 110 ir_node *be_get_Copy_op(const ir_node *cpy);
 111 /** Sets the Copy Argument. */
 112 void be_set_Copy_op(ir_node *cpy, ir_node *op);
 113
 114 /**
 115  * Make a new Perm node.
 116  */
 117 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *block,
 118                      int n, ir_node *in[]);
 119
 120 /**
 121  * Reduce a Perm.
 122  * Basically, we provide a map to remap the Perm's arguments. If an entry in the
 123  * map is -1, the argument gets deleted.
 124  * This function takes care, that the register data and the input array reflects
 125  * the changes described by the map.
 126  * This is needed by the Perm optimization/movement in belower.c, see
 127  * push_through_perm().
 128  * @param perm     The perm node.
 129  * @param new_size The new number of arguments (must be smaller or equal to the
 130  *                 current one).
 131  * @param map      A map assigning each operand a new index (or -1 to indicate
 132  *                 deletion).
 133  */
 134 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
 135
 136 /**
 137  * Create a new MemPerm node.
 138  * A MemPerm node exchanges the values of memory locations. (Typically entities
 139  * used as spillslots). MemPerm nodes perform this operation without modifying
 140  * any register values.
 141  */
 142 ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *in[]);
 143 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
 144
 145 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
 146                       ir_node *node);
 147
 148 /**
 149  * Position numbers for the be_FrameAddr inputs
 150  */
 151 enum {
 152         n_be_FrameAddr_ptr = 0
 153 };
 154
 155 /** Create a new FrameAddr node. */
 156 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
 157                           ir_node *block, ir_node *frame, ir_entity *ent);
 158
 159 /** Return the frame input of a FrameAddr node. */
 160 ir_node *be_get_FrameAddr_frame(const ir_node *node);
 161
 162 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
 163
 164 /**
 165  * Position numbers for the be_AddSP inputs
 166  */
 167 enum {
 168         n_be_AddSP_old_sp = 0,
 169         n_be_AddSP_size   = 1,
 170         n_be_AddSP_last   = 2
 171 };
 172
 173 enum {
 174         pn_be_AddSP_sp   = 0,
 175         pn_be_AddSP_res  = 1,
 176         pn_be_AddSP_M    = 2,
 177         pn_be_AddSP_last = 3
 178 };
 179
 180 /**
 181  * Make a new AddSP node.
 182  * An AddSP node expresses an increase of the stack pointer in the direction
 183  * the stack grows. In contrast to IncSP, the amount of bytes the stack pointer
 184  * is grown, is not given by a constant but an ordinary Firm node.
 185  * @param sp     The stack pointer register.
 186  * @param block  The block.
 187  * @param old_sp The node representing the old stack pointer value.
 188  * @param size   The node expressing the size by which the stack pointer shall
 189  *               be grown.
 190  * @return       A new AddSP node.
 191  */
 192 ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
 193                       ir_node *old_sp, ir_node *size);
 194
 195 /**
 196  * Position numbers for the be_SubSP inputs
 197  */
 198 enum {
 199         n_be_SubSP_old_sp = 0,
 200         n_be_SubSP_size   = 1,
 201         n_be_SubSP_last   = 2
 202 };
 203
 204 enum {
 205         pn_be_SubSP_sp   = 0,
 206         pn_be_SubSP_M    = 1,
 207         pn_be_SubSP_last = 2
 208 };
 209
 210 /**
 211  * Make a new SubSP node.
 212  * A SubSP node expresses a decrease of the stack pointer in the direction the
 213  * stack grows. In contrast to IncSP, the amount of bytes the stack pointer is
 214  * grown, is not given by a constant but an ordinary Firm node.
 215  * @param sp     The stack pointer register.
 216  * @param block  The block.
 217  * @param old_sp The node representing the old stack pointer value.
 218  * @param size   The node expressing the size by which the stack pointer shall
 219  *               be grown.
 220  * @return       A new DecSP node.
 221  */
 222 ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
 223                       ir_node *old_sp, ir_node *size);
 224
 225 /**
 226  * Make a stack pointer increase/decrease node.
 227  * @param sp     The stack pointer register.
 228  * @param block  The block to insert the node into.
 229  * @param old_sp The node defining the former stack pointer.
 230  * @param offset amount the stack should expand (positive offset) or shrink
 231  *               (negative offset). Note that the offset is independent of the
 232  *               natural stack direction of the architecture but just specifies
 233  *               abstract expanding/shrinking of the stack area.
 234  * @param align  force stack alignment to this power of 2. (ie. specifying 3
 235  *               results in a 2^3 = 8byte stack alignment)
 236  * @return       A new stack pointer increment/decrement node.
 237  * @note         This node sets a register constraint to the @p sp register on
 238  *               its output.
 239  */
 240 ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
 241                       ir_node *old_sp, int offset, int align);
 242
 243 /** Returns the previous node that computes the stack pointer. */
 244 ir_node *be_get_IncSP_pred(ir_node *incsp);
 245
 246 /** Sets the previous node that computes the stack pointer. */
 247 void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
 248
 249 /**
 250  * Sets a new offset to a IncSP node.
 251  * A positive offset means expanding the stack, a negative offset shrinking
 252  * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
 253  * stackframe in the fix_stack_offsets phase.
 254  */
 255 void     be_set_IncSP_offset(ir_node *irn, int offset);
 256
 257 /** Gets the offset from a IncSP node. */
 258 int be_get_IncSP_offset(const ir_node *irn);
 259 int be_get_IncSP_align(const ir_node *irn);
 260
 261 /** Gets the call entity or NULL if this is no static call. */
 262 ir_entity  *be_Call_get_entity(const ir_node *call);
 263 /** Sets the call entity. */
 264 void     be_Call_set_entity(ir_node *call, ir_entity *ent);
 265 /** Gets the call type. */
 266 ir_type *be_Call_get_type(ir_node *call);
 267 /** Sets the call type. */
 268 void     be_Call_set_type(ir_node *call, ir_type *call_tp);
 269
 270 void     be_Call_set_pop(ir_node *call, unsigned pop);
 271
 272 unsigned be_Call_get_pop(const ir_node *call);
 273
 274 /**
 275  * Position numbers for the be_Call inputs.
 276  */
 277 enum {
 278         n_be_Call_mem       = 0,  /**< memory input of a be_Call node */
 279         n_be_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
 280         n_be_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
 281         n_be_Call_first_arg = 3   /**< first argument input of a be_Call node */
 282 };
 283
 284 /**
 285  * Projection numbers for result of be_Call node: use for Proj nodes!
 286  */
 287 typedef enum {
 288         pn_be_Call_M         = pn_Call_M, /**< The memory result of a be_Call. */
 289         pn_be_Call_X_regular = pn_Call_X_regular,
 290         pn_be_Call_X_except  = pn_Call_X_except,
 291         pn_be_Call_sp        = pn_Call_max+1,
 292         pn_be_Call_first_res     /**< The first result proj number of a be_Call. */
 293 } pn_be_Call;
 294
 295 /**
 296  * Construct a new be_Call.
 297  *
 298  * @param dbg      debug info
 299  * @param irg      the graph where the call is placed
 300  * @param block    the block where the call is placed
 301  * @param mem      the memory input of the call
 302  * @param sp       the stack pointer input of the call
 303  * @param ptr      the address of the called function, if immediate call set
 304  *                 to sp
 305  * @param n_outs   the number of outcoming values from this call
 306  * @param n        the number of (register) inputs of this call
 307  * @param in       the (register) inputs of this call
 308  * @param call_tp  the call type of this call
 309  */
 310 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
 311                      ir_node *sp, ir_node *ptr, int n_outs,
 312                      int n, ir_node *in[], ir_type *call_tp);
 313
 314 /**
 315  * Position numbers for the be_Return inputs.
 316  */
 317 enum {
 318         n_be_Return_mem  = 0,     /**< memory input of a be_Return node */
 319         n_be_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
 320         n_be_Return_val  = 2,     /**< first "real" return value if any */
 321 };
 322
 323 /**
 324  * Construct a new be_Return.
 325  *
 326  * @param dbg    debug info
 327  * @param irg    the graph where the new node will be placed
 328  * @param block  the block where the new node will be placed
 329  * @param n_res  number of "real" results
 330  * @param pop    pop number of bytes on return
 331  * @param n      number of inputs
 332  * @param in     input array
 333  */
 334 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
 335                        unsigned pop, int n, ir_node *in[]);
 336
 337 /** Returns the number of real returns values */
 338 int be_Return_get_n_rets(const ir_node *ret);
 339
 340 /**
 341  * Return the number of bytes that should be popped from stack when executing
 342  * the Return.
 343  *
 344  * @param ret  the be_Return node
 345  */
 346 unsigned be_Return_get_pop(const ir_node *ret);
 347
 348 /**
 349  * Return non-zero, if number of popped bytes must be always emitted.
 350  *
 351  * @param ret  the be_Return node
 352  */
 353 int be_Return_get_emit_pop(const ir_node *ret);
 354
 355 /**
 356  * Set the emit_pop flag.
 357  *
 358  * @param ret  the be_Return node
 359  */
 360 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
 361
 362 /** appends a node to the return node, returns the position of the node */
 363 int be_Return_append_node(ir_node *ret, ir_node *node);
 364
 365 ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
 366
 367 /**
 368  * Make a spill node.
 369  *
 370  * @param irn       The node to be spilled.
 371  * @param block     the block where the spill should be placed
 372  * @return          The new spill node.
 373  */
 374 ir_node *be_spill(ir_node *block, ir_node *irn);
 375
 376 /**
 377  * Make a reload and insert it into the schedule.
 378  *
 379  * @param cls      The register class of the reloaded value.
 380  * @param insert   The node in the schedule in front of which the reload is
 381  *                 inserted.
 382  * @param mode     The mode of the original (spilled) value.
 383  * @param spill    The spill node corresponding to this reload.
 384  * @return         A freshly made reload.
 385  */
 386 ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert,
 387                    ir_mode *mode, ir_node *spill);
 388
 389 enum {
 390         n_be_CopyKeep_op = 0
 391 };
 392 ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_node *block,
 393                          ir_node *src, int n, ir_node *in_keep[],
 394                          ir_mode *mode);
 395
 396 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls,
 397                                 ir_node *block, ir_node *src, ir_node *keep,
 398                                 ir_mode *mode);
 399
 400 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
 401
 402 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 403
 404 /**
 405  * Returns the frame entity of a be node.
 406  * Try to avoid this function and better call arch_get_frame_entity!
 407  *
 408  * @return the frame entity used by the be node
 409  */
 410 ir_entity *be_get_frame_entity(const ir_node *irn);
 411
 412 void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
 413
 414 /**
 415  * Returns the frame offset of this node.
 416  */
 417 int be_get_frame_offset(const ir_node *irn);
 418
 419 ir_node* be_get_Reload_mem(const ir_node *irn);
 420 ir_node *be_get_Reload_frame(const ir_node *irn);
 421 ir_node* be_get_Spill_val(const ir_node *irn);
 422 ir_node *be_get_Spill_frame(const ir_node *irn);
 423
 424 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
 425 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
 426
 427 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
 428 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
 429
 430 int be_get_MemPerm_entity_arity(const ir_node *irn);
 431
 432 /**
 433  * Impose a register constraint on a backend node.
 434  * @param irn The node.
 435  * @param pos The position of the argument.
 436  * @param reg The register which is admissible for that node, argument/result
 437  *            and position.
 438  */
 439 void be_set_constr_single_reg_in(ir_node *irn, int pos,
 440                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 441 void be_set_constr_single_reg_out(ir_node *irn, int pos,
 442                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 443
 444 const arch_register_req_t *be_create_reg_req(struct obstack *obst,
 445                 const arch_register_t *reg, arch_register_req_type_t additional_types);
 446
 447 /**
 448  * Impose register constraints on a backend node.
 449  * The register subsets given by the limited function in @p req are copied to
 450  * the backend node. This requires that the constraint type of the @p req is
 451  * arch_register_req_type_limited.
 452  * @param irn The backend node.
 453  * @param pos The position (@see be_set_constr_single_reg()).
 454  * @param req The register requirements which shall be transferred.
 455  */
 456 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
 457 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
 458
 459 /**
 460  * Set the register class of a node.
 461  * @param irn The node itself.
 462  * @param pos The position (0..n) for arguments
 463  * @param flags The register class to set for that node and position.
 464  */
 465 void be_node_set_reg_class_in(ir_node *irn, int pos,
 466                               const arch_register_class_t *cls);
 467 void be_node_set_reg_class_out(ir_node *irn, int pos,
 468                                const arch_register_class_t *cls);
 469
 470 /**
 471  * Set the register requirements for a phi node.
 472  */
 473 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
 474
 475 void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
 476
 477 /**
 478  * Creates a new phi with associated backend informations
 479  */
 480 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
 481                     const arch_register_class_t *cls);
 482
 483 /**
 484  * Search for output of start node with a specific register
 485  */
 486 ir_node *be_get_initial_reg_value(ir_graph *irg, const arch_register_t *reg);
 487
 488 /**
 489  * Search for input of a return node with a specific register and return
 490  * its number.
 491  */
 492 int be_find_return_reg_input(ir_node *ret, const arch_register_t *reg);
 493
 494 static inline int be_is_Spill    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill    ; }
 495 static inline int be_is_Reload   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload   ; }
 496 static inline int be_is_Copy     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy     ; }
 497 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
 498 static inline int be_is_Perm     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm     ; }
 499 static inline int be_is_MemPerm  (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm  ; }
 500 static inline int be_is_Keep     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep     ; }
 501 static inline int be_is_Call     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call     ; }
 502 static inline int be_is_Return   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return   ; }
 503 static inline int be_is_IncSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP    ; }
 504 static inline int be_is_AddSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP    ; }
 505 static inline int be_is_SubSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP    ; }
 506 static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start    ; }
 507 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
 508
 509 #endif