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