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