nsz Git - libfirm/blob - ir/be/benode_t.h

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