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