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