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