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

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