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