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