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