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