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