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  *
  26  * Backend node support for generic backend nodes.
  27  * This file provides Perm, Copy, Spill and Reload nodes.
  28  */
  29 #ifndef FIRM_BE_BENODE_T_H
  30 #define FIRM_BE_BENODE_T_H
  31
  32 #include <limits.h>
  33
  34 #include "firm_types.h"
  35 #include "irnode_t.h"
  36 #include "bearch.h"
  37
  38 /**
  39  * The benode op's.  Must be available to register emitter function.
  40  */
  41 extern ir_op *op_be_Spill;
  42 extern ir_op *op_be_Reload;
  43 extern ir_op *op_be_Perm;
  44 extern ir_op *op_be_MemPerm;
  45 extern ir_op *op_be_Copy;
  46 extern ir_op *op_be_Keep;
  47 extern ir_op *op_be_CopyKeep;
  48 extern ir_op *op_be_Call;
  49 extern ir_op *op_be_Return;
  50 extern ir_op *op_be_IncSP;
  51 extern ir_op *op_be_AddSP;
  52 extern ir_op *op_be_SubSP;
  53 extern ir_op *op_be_Start;
  54 extern ir_op *op_be_FrameAddr;
  55
  56 /**
  57  * Determines if irn is a be_node.
  58  */
  59 int is_be_node(const ir_node *irn);
  60
  61 /**
  62  * Create all BE specific opcodes.
  63  */
  64 void be_init_op(void);
  65
  66 void be_finish_op(void);
  67
  68 /**
  69  * Position numbers for the be_Spill inputs.
  70  */
  71 enum {
  72         n_be_Spill_frame = 0,
  73         n_be_Spill_val   = 1
  74 };
  75
  76 /**
  77  * Make a new Spill node.
  78  */
  79 ir_node *be_new_Spill(const arch_register_class_t *cls,
  80                       const arch_register_class_t *cls_frame, ir_node *block,
  81                       ir_node *frame, ir_node *to_spill);
  82
  83 /**
  84  * Position numbers for the be_Reload inputs.
  85  */
  86 enum {
  87         n_be_Reload_frame = 0,
  88         n_be_Reload_mem   = 1
  89 };
  90
  91 /**
  92  * Make a new Reload node.
  93  */
  94 ir_node *be_new_Reload(const arch_register_class_t *cls,
  95                        const arch_register_class_t *cls_frame, ir_node *block,
  96                        ir_node *frame, ir_node *mem, ir_mode *mode);
  97
  98 /**
  99  * Position numbers for the be_Copy inputs.
 100  */
 101 enum {
 102         n_be_Copy_op = 0
 103 };
 104
 105 /**
 106  * Make a new Copy node.
 107  */
 108 ir_node *be_new_Copy(ir_node *block, 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                      const arch_register_req_t *sp_req, ir_node *sp,
 312                      const arch_register_req_t *ptr_req, ir_node *ptr,
 313                      int n_outs, int n, ir_node *in[], ir_type *call_tp);
 314
 315 /**
 316  * Position numbers for the be_Return inputs.
 317  */
 318 enum {
 319         n_be_Return_mem  = 0,     /**< memory input of a be_Return node */
 320         n_be_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
 321         n_be_Return_val  = 2,     /**< first "real" return value if any */
 322 };
 323
 324 /**
 325  * Construct a new be_Return.
 326  *
 327  * @param dbg    debug info
 328  * @param irg    the graph where the new node will be placed
 329  * @param block  the block where the new node will be placed
 330  * @param n_res  number of "real" results
 331  * @param pop    pop number of bytes on return
 332  * @param n      number of inputs
 333  * @param in     input array
 334  */
 335 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
 336                        unsigned pop, int n, ir_node *in[]);
 337
 338 /** Returns the number of real returns values */
 339 int be_Return_get_n_rets(const ir_node *ret);
 340
 341 /**
 342  * Return the number of bytes that should be popped from stack when executing
 343  * the Return.
 344  *
 345  * @param ret  the be_Return node
 346  */
 347 unsigned be_Return_get_pop(const ir_node *ret);
 348
 349 /**
 350  * Return non-zero, if number of popped bytes must be always emitted.
 351  *
 352  * @param ret  the be_Return node
 353  */
 354 int be_Return_get_emit_pop(const ir_node *ret);
 355
 356 /**
 357  * Set the emit_pop flag.
 358  *
 359  * @param ret  the be_Return node
 360  */
 361 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
 362
 363 ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
 364
 365 enum {
 366         n_be_CopyKeep_op = 0
 367 };
 368 ir_node *be_new_CopyKeep(ir_node *block, ir_node *src,
 369                          int n, ir_node *in_keep[]);
 370
 371 ir_node *be_new_CopyKeep_single(ir_node *block, ir_node *src, ir_node *keep);
 372
 373 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
 374
 375 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 376
 377 /**
 378  * Returns the frame entity of a be node.
 379  * Try to avoid this function and better call arch_get_frame_entity!
 380  *
 381  * @return the frame entity used by the be node
 382  */
 383 ir_entity *be_get_frame_entity(const ir_node *irn);
 384
 385 void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
 386
 387 /**
 388  * Returns the frame offset of this node.
 389  */
 390 int be_get_frame_offset(const ir_node *irn);
 391
 392 ir_node* be_get_Reload_mem(const ir_node *irn);
 393 ir_node *be_get_Reload_frame(const ir_node *irn);
 394 ir_node* be_get_Spill_val(const ir_node *irn);
 395 ir_node *be_get_Spill_frame(const ir_node *irn);
 396
 397 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
 398 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
 399
 400 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
 401 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
 402
 403 int be_get_MemPerm_entity_arity(const ir_node *irn);
 404
 405 /**
 406  * Impose a register constraint on a backend node.
 407  * @param irn The node.
 408  * @param pos The position of the argument.
 409  * @param reg The register which is admissible for that node, argument/result
 410  *            and position.
 411  */
 412 void be_set_constr_single_reg_in(ir_node *irn, int pos,
 413                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 414 void be_set_constr_single_reg_out(ir_node *irn, int pos,
 415                 const arch_register_t *reg, arch_register_req_type_t additional_flags);
 416
 417 const arch_register_req_t *be_create_reg_req(struct obstack *obst,
 418                 const arch_register_t *reg, arch_register_req_type_t additional_types);
 419
 420 /**
 421  * Impose register constraints on a backend node.
 422  * The register subsets given by the limited function in @p req are copied to
 423  * the backend node. This requires that the constraint type of the @p req is
 424  * arch_register_req_type_limited.
 425  * @param irn The backend node.
 426  * @param pos The position (@see be_set_constr_single_reg()).
 427  * @param req The register requirements which shall be transferred.
 428  */
 429 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
 430 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
 431
 432 /**
 433  * Set the register class of a node.
 434  * @param irn The node itself.
 435  * @param pos The position (0..n) for arguments
 436  * @param flags The register class to set for that node and position.
 437  */
 438 void be_node_set_reg_class_in(ir_node *irn, int pos,
 439                               const arch_register_class_t *cls);
 440 void be_node_set_reg_class_out(ir_node *irn, int pos,
 441                                const arch_register_class_t *cls);
 442
 443 /**
 444  * Set the register requirements for a phi node.
 445  */
 446 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
 447
 448 void be_dump_phi_reg_reqs(FILE *out, const ir_node *node, dump_reason_t reason);
 449
 450 /**
 451  * Creates a new phi with associated backend informations
 452  */
 453 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
 454                     const arch_register_req_t *req);
 455
 456 /**
 457  * Search for output of start node with a specific register
 458  */
 459 ir_node *be_get_initial_reg_value(ir_graph *irg, const arch_register_t *reg);
 460
 461 /**
 462  * Search for input of a return node with a specific register and return
 463  * its number.
 464  */
 465 int be_find_return_reg_input(ir_node *ret, const arch_register_t *reg);
 466
 467 static inline int be_is_Spill    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill    ; }
 468 static inline int be_is_Reload   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload   ; }
 469 static inline int be_is_Copy     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy     ; }
 470 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
 471 static inline int be_is_Perm     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm     ; }
 472 static inline int be_is_MemPerm  (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm  ; }
 473 static inline int be_is_Keep     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep     ; }
 474 static inline int be_is_Call     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call     ; }
 475 static inline int be_is_Return   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return   ; }
 476 static inline int be_is_IncSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP    ; }
 477 static inline int be_is_AddSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP    ; }
 478 static inline int be_is_SubSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP    ; }
 479 static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start    ; }
 480 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
 481
 482 #endif