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(ir_node *block, int n, ir_node *in[]);
 151 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
 152
 153 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
 154                       ir_node *node);
 155
 156 /**
 157  * Position numbers for the be_FrameAddr inputs
 158  */
 159 enum {
 160         be_pos_FrameAddr_ptr = 0
 161 };
 162
 163 /** Create a new FrameAddr node. */
 164 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
 165                           ir_node *block, ir_node *frame, ir_entity *ent);
 166
 167 /** Return the frame input of a FrameAddr node. */
 168 ir_node *be_get_FrameAddr_frame(const ir_node *node);
 169
 170 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
 171
 172 /**
 173  * Position numbers for the be_AddSP inputs
 174  */
 175 enum {
 176         be_pos_AddSP_old_sp = 0,
 177         be_pos_AddSP_size   = 1,
 178         be_pos_AddSP_last   = 2
 179 };
 180
 181 enum {
 182         pn_be_AddSP_sp   = 0,
 183         pn_be_AddSP_res  = 1,
 184         pn_be_AddSP_M    = 2,
 185         pn_be_AddSP_last = 3
 186 };
 187
 188 /**
 189  * Make a new AddSP node.
 190  * An AddSP node expresses an increase of the stack pointer in the direction
 191  * the stack grows. In contrast to IncSP, the amount of bytes the stack pointer
 192  * is grown, is not given by a constant but an ordinary Firm node.
 193  * @param sp     The stack pointer register.
 194  * @param block  The block.
 195  * @param old_sp The node representing the old stack pointer value.
 196  * @param size   The node expressing the size by which the stack pointer shall
 197  *               be grown.
 198  * @return       A new AddSP node.
 199  */
 200 ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
 201                       ir_node *old_sp, ir_node *size);
 202
 203 /**
 204  * Position numbers for the be_SubSP inputs
 205  */
 206 enum {
 207         be_pos_SubSP_old_sp = 0,
 208         be_pos_SubSP_size   = 1,
 209         be_pos_SubSP_last   = 2
 210 };
 211
 212 enum {
 213         pn_be_SubSP_sp   = 0,
 214         pn_be_SubSP_M    = 1,
 215         pn_be_SubSP_last = 2
 216 };
 217
 218 /**
 219  * Make a new SubSP node.
 220  * A SubSP node expresses a decrease of the stack pointer in the direction the
 221  * stack grows. In contrast to IncSP, the amount of bytes the stack pointer is
 222  * grown, is not given by a constant but an ordinary Firm node.
 223  * @param sp     The stack pointer register.
 224  * @param block  The block.
 225  * @param old_sp The node representing the old stack pointer value.
 226  * @param size   The node expressing the size by which the stack pointer shall
 227  *               be grown.
 228  * @return       A new DecSP node.
 229  */
 230 ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
 231                       ir_node *old_sp, ir_node *size);
 232
 233 /**
 234  * Make a stack pointer increase/decrease node.
 235  * @param sp     The stack pointer register.
 236  * @param block  The block to insert the node into.
 237  * @param old_sp The node defining the former stack pointer.
 238  * @param offset amount the stack should expand (positive offset) or shrink
 239  *               (negative offset). Note that the offset is independent of the
 240  *               natural stack direction of the architecture but just specifies
 241  *               abstract expanding/shrinking of the stack area.
 242  * @param align  force stack alignment to this power of 2. (ie. specifying 3
 243  *               results in a 2^3 = 8byte stack alignment)
 244  * @return       A new stack pointer increment/decrement node.
 245  * @note         This node sets a register constraint to the @p sp register on
 246  *               its output.
 247  */
 248 ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
 249                       ir_node *old_sp, int offset, int align);
 250
 251 /** Returns the previous node that computes the stack pointer. */
 252 ir_node *be_get_IncSP_pred(ir_node *incsp);
 253
 254 /** Sets the previous node that computes the stack pointer. */
 255 void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
 256
 257 /**
 258  * Sets a new offset to a IncSP node.
 259  * A positive offset means expanding the stack, a negative offset shrinking
 260  * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
 261  * stackframe in the fix_stack_offsets phase.
 262  */
 263 void     be_set_IncSP_offset(ir_node *irn, int offset);
 264
 265 /** Gets the offset from a IncSP node. */
 266 int be_get_IncSP_offset(const ir_node *irn);
 267 int be_get_IncSP_align(const ir_node *irn);
 268
 269 /** Gets the call entity or NULL if this is no static call. */
 270 ir_entity  *be_Call_get_entity(const ir_node *call);
 271 /** Sets the call entity. */
 272 void     be_Call_set_entity(ir_node *call, ir_entity *ent);
 273 /** Gets the call type. */
 274 ir_type *be_Call_get_type(ir_node *call);
 275 /** Sets the call type. */
 276 void     be_Call_set_type(ir_node *call, ir_type *call_tp);
 277
 278 void     be_Call_set_pop(ir_node *call, unsigned pop);
 279
 280 unsigned be_Call_get_pop(const ir_node *call);
 281
 282 /**
 283  * Position numbers for the be_Call inputs.
 284  */
 285 enum {
 286         be_pos_Call_mem       = 0,  /**< memory input of a be_Call node */
 287         be_pos_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
 288         be_pos_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
 289         be_pos_Call_first_arg = 3   /**< first argument input of a be_Call node */
 290 };
 291
 292 /**
 293  * Projection numbers for result of be_Call node: use for Proj nodes!
 294  */
 295 typedef enum {
 296         pn_be_Call_M_regular = pn_Call_M,    /**< The memory result of a be_Call. */
 297         pn_be_Call_sp        = pn_Call_max,
 298         pn_be_Call_first_res                 /**< The first result proj number of a
 299                                                   be_Call. */
 300 } pn_be_Call;
 301
 302 /**
 303  * Construct a new be_Call.
 304  *
 305  * @param dbg      debug info
 306  * @param irg      the graph where the call is placed
 307  * @param block    the block where the call is placed
 308  * @param mem      the memory input of the call
 309  * @param sp       the stack pointer input of the call
 310  * @param ptr      the address of the called function, if immediate call set
 311  *                 to sp
 312  * @param n_outs   the number of outcoming values from this call
 313  * @param n        the number of (register) inputs of this call
 314  * @param in       the (register) inputs of this call
 315  * @param call_tp  the call type of this call
 316  */
 317 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
 318                      ir_node *sp, ir_node *ptr, int n_outs,
 319                      int n, ir_node *in[], ir_type *call_tp);
 320
 321 /**
 322  * Position numbers for the be_Return inputs.
 323  */
 324 enum {
 325         be_pos_Return_mem  = 0,     /**< memory input of a be_Return node */
 326         be_pos_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
 327         be_pos_Return_val  = 2,     /**< first "real" return value if any */
 328 };
 329
 330 /**
 331  * Construct a new be_Return.
 332  *
 333  * @param dbg    debug info
 334  * @param irg    the graph where the new node will be placed
 335  * @param block  the block where the new node will be placed
 336  * @param n_res  number of "real" results
 337  * @param pop    pop number of bytes on return
 338  * @param n      number of inputs
 339  * @param in     input array
 340  */
 341 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
 342                        unsigned pop, int n, ir_node *in[]);
 343
 344 /** Returns the number of real returns values */
 345 int be_Return_get_n_rets(const ir_node *ret);
 346
 347 /**
 348  * Return the number of bytes that should be popped from stack when executing
 349  * the Return.
 350  *
 351  * @param ret  the be_Return node
 352  */
 353 unsigned be_Return_get_pop(const ir_node *ret);
 354
 355 /**
 356  * Return non-zero, if number of popped bytes must be always emitted.
 357  *
 358  * @param ret  the be_Return node
 359  */
 360 int be_Return_get_emit_pop(const ir_node *ret);
 361
 362 /**
 363  * Set the emit_pop flag.
 364  *
 365  * @param ret  the be_Return node
 366  */
 367 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
 368
 369 /** appends a node to the return node, returns the position of the node */
 370 int be_Return_append_node(ir_node *ret, ir_node *node);
 371
 372 ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
 373
 374 ir_node *be_new_Barrier(ir_node *block, int n, ir_node *in[]);
 375
 376 /**
 377  * Appends a node to a barrier, returns the result proj of the node
 378  */
 379 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
 380
 381 /**
 382  * Make a spill node.
 383  *
 384  * @param irn       The node to be spilled.
 385  * @param block     the block where the spill should be placed
 386  * @return          The new spill node.
 387  */
 388 ir_node *be_spill(ir_node *block, ir_node *irn);
 389
 390 /**
 391  * Make a reload and insert it into the schedule.
 392  *
 393  * @param cls      The register class of the reloaded value.
 394  * @param insert   The node in the schedule in front of which the reload is
 395  *                 inserted.
 396  * @param mode     The mode of the original (spilled) value.
 397  * @param spill    The spill node corresponding to this reload.
 398  * @return         A freshly made reload.
 399  */
 400 ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert,
 401                    ir_mode *mode, ir_node *spill);
 402
 403 enum {
 404         be_pos_CopyKeep_op = 0
 405 };
 406 ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_node *block,
 407                          ir_node *src, int n, ir_node *in_keep[],
 408                          ir_mode *mode);
 409
 410 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls,
 411                                 ir_node *block, ir_node *src, ir_node *keep,
 412                                 ir_mode *mode);
 413
 414 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
 415
 416 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 417
 418 /**
 419  * Returns the frame entity of a be node.
 420  * Try to avoid this function and better call arch_get_frame_entity!
 421  *
 422  * @return the frame entity used by the be node
 423  */
 424 ir_entity *be_get_frame_entity(const ir_node *irn);
 425
 426 void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
 427
 428 /**
 429  * Returns the frame offset of this node.
 430  */
 431 int be_get_frame_offset(const ir_node *irn);
 432
 433 ir_node* be_get_Reload_mem(const ir_node *irn);
 434 ir_node *be_get_Reload_frame(const ir_node *irn);
 435 ir_node* be_get_Spill_val(const ir_node *irn);
 436 ir_node *be_get_Spill_frame(const ir_node *irn);
 437
 438 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
 439 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
 440
 441 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
 442 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
 443
 444 int be_get_MemPerm_entity_arity(const ir_node *irn);
 445
 446 /**
 447  * Impose a register constraint on a backend node.
 448  * @param irn The node.
 449  * @param pos The position of the argument.
 450  * @param reg The register which is admissible for that node, argument/result
 451  *            and position.
 452  */
 453 void be_set_constr_single_reg_in(ir_node *irn, int pos,
 454                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 455 void be_set_constr_single_reg_out(ir_node *irn, int pos,
 456                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 457
 458 const arch_register_req_t *be_create_reg_req(struct obstack *obst,
 459                 const arch_register_t *reg, arch_register_req_type_t additional_types);
 460
 461 /**
 462  * Impose register constraints on a backend node.
 463  * The register subsets given by the limited function in @p req are copied to
 464  * the backend node. This requires that the constraint type of the @p req is
 465  * arch_register_req_type_limited.
 466  * @param irn The backend node.
 467  * @param pos The position (@see be_set_constr_single_reg()).
 468  * @param req The register requirements which shall be transferred.
 469  */
 470 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
 471 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
 472
 473 /**
 474  * Set the register class of a node.
 475  * @param irn The node itself.
 476  * @param pos The position (0..n) for arguments
 477  * @param flags The register class to set for that node and position.
 478  */
 479 void be_node_set_reg_class_in(ir_node *irn, int pos,
 480                               const arch_register_class_t *cls);
 481 void be_node_set_reg_class_out(ir_node *irn, int pos,
 482                                const arch_register_class_t *cls);
 483
 484 /**
 485  * Set the register requirements for a phi node.
 486  */
 487 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
 488
 489 void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
 490
 491 /**
 492  * Creates a new phi with associated backend informations
 493  */
 494 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
 495                     const arch_register_class_t *cls);
 496
 497 /**
 498  * irn handler for common be nodes and Phi's.
 499  */
 500 const void *be_node_get_irn_ops(const ir_node *irn);
 501
 502 static inline int be_is_Spill    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill    ; }
 503 static inline int be_is_Reload   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload   ; }
 504 static inline int be_is_Copy     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy     ; }
 505 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
 506 static inline int be_is_Perm     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm     ; }
 507 static inline int be_is_MemPerm  (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm  ; }
 508 static inline int be_is_Keep     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep     ; }
 509 static inline int be_is_Call     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call     ; }
 510 static inline int be_is_Return   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return   ; }
 511 static inline int be_is_IncSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP    ; }
 512 static inline int be_is_AddSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP    ; }
 513 static inline int be_is_SubSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP    ; }
 514 static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
 515 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
 516 static inline int be_is_Barrier  (const ir_node *irn) { return get_irn_opcode(irn) == beo_Barrier  ; }
 517
 518 #endif