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 #include "pmap.h"
  17
  18 #include "irmode.h"
  19 #include "irnode.h"
  20 #include "entity_t.h"
  21
  22 #include "be_t.h"
  23 #include "bearch.h"
  24
  25 #define BE_OUT_POS(p) (-((p) + 1))
  26
  27 /**
  28  * The benode op's.  Must be available to register emitter function.
  29  */
  30 extern ir_op *op_be_Spill;
  31 extern ir_op *op_be_Reload;
  32 extern ir_op *op_be_Perm;
  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_Copy,
  54         beo_Keep,
  55         beo_CopyKeep,
  56         beo_Call,
  57         beo_Return,
  58         beo_AddSP,
  59         beo_IncSP,
  60         beo_SetSP,
  61         beo_RegParams,
  62         beo_StackParam,
  63         beo_FrameLoad,
  64         beo_FrameStore,
  65         beo_FrameAddr,
  66         beo_Barrier,
  67         beo_Last
  68 } be_opcode_t;
  69
  70 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
  71 typedef enum {
  72         be_stack_dir_expand = 0,
  73         be_stack_dir_shrink = 1
  74 } be_stack_dir_t;
  75
  76 /** Not used yet. */
  77 typedef enum {
  78         be_frame_flag_spill = 1,
  79         be_frame_flag_local = 2,
  80         be_frame_flag_arg   = 4
  81 } be_frame_flag_t;
  82
  83 /**
  84  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
  85  * It gets back-patched to the real size as soon it is known.
  86  */
  87 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
  88
  89 /**
  90  * Create all BE specific opcodes.
  91  */
  92 void be_node_init(void);
  93
  94 enum {
  95         be_pos_Spill_frame = 0,
  96         be_pos_Spill_val   = 1
  97 };
  98 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, ir_node *ctx);
  99
 100 enum {
 101         be_pos_Reload_frame = 0,
 102         be_pos_Reload_mem   = 1
 103 };
 104 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);
 105
 106 enum {
 107         be_pos_Copy_op = 0
 108 };
 109 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
 110 ir_node *be_get_Copy_op(const ir_node *cpy);
 111
 112 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 113 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 114
 115 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
 116                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
 117 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
 118                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
 119 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
 120
 121 enum {
 122         be_pos_AddSP_old_sp = 0,
 123         be_pos_AddSP_size   = 1,
 124         be_pos_AddSP_last   = 2
 125 };
 126
 127 /**
 128  * Make a new AddSP node.
 129  * An AddSP node expresses an increase of the stack pointer in the direction the stack
 130  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
 131  * given by a constant but an ordinary Firm node.
 132  * @param sp     The stack pointer register.
 133  * @param irg    The graph.
 134  * @param bl     The block.
 135  * @param old_sp The node representing the old stack pointer value.
 136  * @param sz     The node expressing the size by which the stack pointer shall be grown.
 137  * @return       A new AddSP node.
 138  */
 139 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
 140
 141 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);
 142
 143 /**
 144  * Make a stack pointer increase/decrease node.
 145  * @param sp     The stack pointer register.
 146  * @param irg    The graph to insert the node to.
 147  * @param bl     The block to insert the node into.
 148  * @param old_sp The node defining the former stack pointer.
 149  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
 150  * @param dir    The direction in which the stack pointer shall be modified:
 151  *               Along the stack's growing direction or against.
 152  * @return       A new stack pointer increment/decrement node.
 153  * @note         This node sets a register constraint to the @p sp register on its output.
 154  */
 155 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);
 156
 157 /** Returns the previous node that computes the stack pointer. */
 158 ir_node *be_get_IncSP_pred(ir_node *incsp);
 159
 160 /** Returns the memory input of the IncSP. */
 161 ir_node *be_get_IncSP_mem(ir_node *irn);
 162
 163 /** Sets a new offset to a IncSP node. */
 164 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
 165
 166 /** Gets the offset from a IncSP node. */
 167 unsigned be_get_IncSP_offset(const ir_node *irn);
 168
 169 /** Sets a new direction to a IncSP node. */
 170 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
 171
 172 /** Gets the direction from a IncSP node. */
 173 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
 174
 175 /** Gets the call entity or NULL if this is no static call. */
 176 entity  *be_Call_get_entity(const ir_node *call);
 177 /** Sets the call entity. */
 178 void     be_Call_set_entity(ir_node *call, entity *ent);
 179 /** Gets the call type. */
 180 ir_type *be_Call_get_type(ir_node *call);
 181 /** Sets the call type. */
 182 void     be_Call_set_type(ir_node *call, ir_type *call_tp);
 183
 184 enum {
 185         be_pos_Call_mem       = 0,  /**< memory input of a be_Call node */
 186         be_pos_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
 187         be_pos_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
 188         be_pos_Call_first_arg = 3   /**< first argument input of a be_Call node */
 189 };
 190
 191 /**
 192  * Projection numbers for result of be_Call node: use for Proj nodes!
 193  */
 194 typedef enum {
 195         pn_be_Call_M_regular = pn_Call_M_regular,  /**< The memory result of a be_Call. */
 196         pn_be_Call_first_res = pn_Call_max         /**< The first result proj number of a be_Call. */
 197 } pn_be_Call;
 198
 199 /**
 200  * Construct a new be_Call
 201  */
 202 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
 203                      int n_outs, int n, ir_node *in[], ir_type *call_tp);
 204
 205 /**
 206  * Construct a new be_Return
 207  */
 208 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 209 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);
 210 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
 211
 212 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 213
 214 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn, ir_node *spill_ctx);
 215 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *reloader, ir_mode *mode, ir_node *spill);
 216
 217 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);
 218 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);
 219
 220
 221 /**
 222  * Get the backend opcode of a backend node.
 223  * @param irn The node.
 224  * @return The backend opcode.
 225  */
 226 be_opcode_t be_get_irn_opcode(const ir_node *irn);
 227
 228 int be_is_Spill(const ir_node *irn);
 229 int be_is_Reload(const ir_node *irn);
 230 int be_is_Copy(const ir_node *irn);
 231 int be_is_Perm(const ir_node *irn);
 232 int be_is_Keep(const ir_node *irn);
 233 int be_is_CopyKeep(const ir_node *irn);
 234 int be_is_Call(const ir_node *irn);
 235 int be_is_Return(const ir_node *irn);
 236 int be_is_IncSP(const ir_node *irn);
 237 int be_is_SetSP(const ir_node *irn);
 238 int be_is_AddSP(const ir_node *irn);
 239 int be_is_RegParams(const ir_node *irn);
 240 int be_is_StackParam(const ir_node *irn);
 241 int be_is_FrameAddr(const ir_node *irn);
 242 int be_is_FrameLoad(const ir_node *irn);
 243 int be_is_FrameStore(const ir_node *irn);
 244 int be_is_Barrier(const ir_node *irn);
 245
 246 /**
 247  * Get the entity on the stack frame the given node uses.
 248  * @param irn The node.
 249  * @return The entity on the stack frame used by the node or NULL,
 250  *         if the node does not access the stack frame or is no back-end node.
 251  *
 252  */
 253 entity *be_get_frame_entity(const ir_node *irn);
 254
 255 void   be_set_Spill_entity(ir_node *irn, entity *ent);
 256 entity *be_get_spill_entity(const ir_node *irn);
 257
 258 ir_node *be_get_Spill_context(const ir_node *irn);
 259
 260 /**
 261  * Set the entities of a Reload to the ones of the Spill it is pointing to.
 262  * @param irg The graph.
 263  */
 264 void be_copy_entities_to_reloads(ir_graph *irg);
 265
 266 /**
 267  * Impose a register constraint on a backend node.
 268  * @param irn The node.
 269  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
 270  * @param reg The register which is admissible for that node, argument/result and position.
 271  */
 272 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
 273
 274 /**
 275  * Impose register constraints on a backend node.
 276  * The register subsets given by the limited function in @p req are copied to the backend node.
 277  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
 278  * @param irn The backend node.
 279  * @param pos The position (@see be_set_constr_single_reg()).
 280  * @param req The register requirements which shall be transferred.
 281  */
 282 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
 283
 284 /**
 285  * Set the flags of a node.
 286  * @param irn The node itself.
 287  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 288  * @param flags The flags to set for that node and position.
 289  */
 290 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
 291
 292 /**
 293  * Set the register class of a node.
 294  * @param irn The node itself.
 295  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 296  * @param flags The register class to set for that node and position.
 297  */
 298 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
 299
 300 /**
 301  * Make a new phi handler.
 302  * @param env The architecture environment.
 303  * @return A new phi handler.
 304  */
 305 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
 306
 307 /**
 308  * Free a phi handler.
 309  * @param handler The handler to free.
 310  */
 311 void be_phi_handler_free(arch_irn_handler_t *handler);
 312
 313 /**
 314  * Reset the register data in the phi handler.
 315  * This should be called on each new graph and deletes the register information of the current graph.
 316  */
 317 void be_phi_handler_reset(arch_irn_handler_t *handler);
 318
 319 /**
 320  * irn handler for common be nodes.
 321  */
 322 extern const arch_irn_handler_t be_node_irn_handler;
 323
 324 #endif /* _BENODE_T_H */