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