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_Call;
  36 extern ir_op *op_be_Return;
  37 extern ir_op *op_be_IncSP;
  38 extern ir_op *op_be_AddSP;
  39 extern ir_op *op_be_SetSP;
  40 extern ir_op *op_be_RegParams;
  41 extern ir_op *op_be_StackParam;
  42 extern ir_op *op_be_FrameAddr;
  43 extern ir_op *op_be_FrameLoad;
  44 extern ir_op *op_be_FrameStore;
  45 extern ir_op *op_be_Barrier;
  46
  47 typedef enum {
  48         beo_NoBeOp = 0,
  49         beo_Spill,
  50         beo_Reload,
  51         beo_Perm,
  52         beo_Copy,
  53         beo_Keep,
  54         beo_CopyKeep,
  55         beo_Call,
  56         beo_Return,
  57         beo_AddSP,
  58         beo_IncSP,
  59         beo_SetSP,
  60         beo_RegParams,
  61         beo_StackParam,
  62         beo_FrameLoad,
  63         beo_FrameStore,
  64         beo_FrameAddr,
  65         beo_Barrier,
  66         beo_Last
  67 } be_opcode_t;
  68
  69 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
  70 typedef enum {
  71         be_stack_dir_expand = 0,
  72         be_stack_dir_shrink = 1
  73 } be_stack_dir_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 ((unsigned) -1)
  87
  88 void be_node_init(void);
  89
  90 enum {
  91         be_pos_Spill_frame = 0,
  92         be_pos_Spill_val   = 1
  93 };
  94 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);
  95
  96 enum {
  97         be_pos_Reload_frame = 0,
  98         be_pos_Reload_mem   = 1
  99 };
 100 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);
 101
 102 enum {
 103         be_pos_Copy_orig = 0
 104 };
 105 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
 106 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 107 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 108
 109 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
 110                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
 111 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
 112                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
 113 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
 114
 115 enum {
 116         be_pos_AddSP_old_sp = 0,
 117         be_pos_AddSP_size   = 1,
 118         be_pos_AddSP_last   = 2
 119 };
 120
 121 /**
 122  * Make a new AddSP node.
 123  * An AddSP node expresses an increase of the stack pointer in the direction the stack
 124  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
 125  * given by a constant but an ordinary Firm node.
 126  * @param sp     The stack pointer register.
 127  * @param irg    The graph.
 128  * @param bl     The block.
 129  * @param old_sp The node representing the old stack pointer value.
 130  * @param sz     The node expressing the size by which the stack pointer shall be grown.
 131  * @return       A new AddSP node.
 132  */
 133 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
 134
 135 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);
 136
 137 /**
 138  * Make a stack pointer increase/decrease node.
 139  * @param sp     The stack pointer register.
 140  * @param irg    The graph to insert the node to.
 141  * @param bl     The block to insert the node into.
 142  * @param old_sp The node defining the former stack pointer.
 143  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
 144  * @param dir    The direction in which the stack pointer shall be modified:
 145  *               Along the stack's growing direction or against.
 146  * @return       A new stack pointer increment/decrement node.
 147  * @note         This node sets a register constraint to the @p sp register on its output.
 148  */
 149 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);
 150
 151
 152
 153 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
 154 unsigned be_get_IncSP_offset(const ir_node *irn);
 155
 156 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
 157 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
 158
 159 entity *be_Call_get_entity(const ir_node *call);
 160 void    be_Call_set_entity(ir_node *call, entity *ent);
 161
 162 enum {
 163         be_pos_Call_mem       = 0,
 164         be_pos_Call_sp        = 1,
 165         be_pos_Call_ptr       = 2,
 166         be_pos_Call_first_arg = 3
 167 };
 168
 169 ir_node *be_new_Call(ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr, int n_outs, int n, ir_node *in[]);
 170 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 171 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);
 172 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
 173
 174 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 175
 176 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
 177 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);
 178
 179 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);
 180 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);
 181
 182
 183 /**
 184  * Get the backend opcode of a backend node.
 185  * @param irn The node.
 186  * @return The backend opcode.
 187  */
 188 be_opcode_t be_get_irn_opcode(const ir_node *irn);
 189
 190 int be_is_Spill(const ir_node *irn);
 191 int be_is_Reload(const ir_node *irn);
 192 int be_is_Copy(const ir_node *irn);
 193 int be_is_Perm(const ir_node *irn);
 194 int be_is_Keep(const ir_node *irn);
 195 int be_is_CopyKeep(const ir_node *irn);
 196 int be_is_Call(const ir_node *irn);
 197 int be_is_Return(const ir_node *irn);
 198 int be_is_IncSP(const ir_node *irn);
 199 int be_is_SetSP(const ir_node *irn);
 200 int be_is_AddSP(const ir_node *irn);
 201 int be_is_RegParams(const ir_node *irn);
 202 int be_is_StackParam(const ir_node *irn);
 203 int be_is_FrameAddr(const ir_node *irn);
 204 int be_is_FrameLoad(const ir_node *irn);
 205 int be_is_FrameStore(const ir_node *irn);
 206 int be_is_Barrier(const ir_node *irn);
 207
 208 /**
 209  * Get the entity on the stack frame the given node uses.
 210  * @param irn The node.
 211  * @return The entity on the stack frame used by the node or NULL,
 212  *         if the node does not access the stack frame or is no back-end node.
 213  *
 214  */
 215 entity *be_get_frame_entity(const ir_node *irn);
 216
 217 void   be_set_Spill_entity(ir_node *irn, entity *ent);
 218 entity *be_get_spill_entity(const ir_node *irn);
 219
 220 ir_node *be_get_Spill_context(const ir_node *irn);
 221
 222 /**
 223  * Set the entities of a Reload to the ones of the Spill it is pointing to.
 224  * @param irg The graph.
 225  */
 226 void be_copy_entities_to_reloads(ir_graph *irg);
 227
 228 /**
 229  * Impose a register constraint on a backend node.
 230  * @param irn The node.
 231  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
 232  * @param reg The register which is admissible for that node, argument/result and position.
 233  */
 234 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
 235
 236 /**
 237  * Impose register constraints on a backend node.
 238  * The register subsets given by the limited function in @p req are copied to the backend node.
 239  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
 240  * @param irn The backend node.
 241  * @param pos The position (@see be_set_constr_single_reg()).
 242  * @param req The register requirements which shall be transferred.
 243  */
 244 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
 245
 246 /**
 247  * Set the flags of a node.
 248  * @param irn The node itself.
 249  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 250  * @param flags The flags to set for that node and position.
 251  */
 252 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
 253
 254 /**
 255  * Set the register class of a node.
 256  * @param irn The node itself.
 257  * @param pos The position (0..n) for arguments, (-1..-m) for results.
 258  * @param flags The register class to set for that node and position.
 259  */
 260 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
 261
 262 /**
 263  * Make a new phi handler.
 264  * @param env The architecture environment.
 265  * @return A new phi handler.
 266  */
 267 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
 268
 269 /**
 270  * Free a phi handler.
 271  * @param handler The handler to free.
 272  */
 273 void be_phi_handler_free(arch_irn_handler_t *handler);
 274
 275 /**
 276  * Reset the register data in the phi handler.
 277  * This should be called on each new graph and deletes the register information of the current graph.
 278  */
 279 void be_phi_handler_reset(arch_irn_handler_t *handler);
 280
 281 /**
 282  * irn handler for common be nodes.
 283  */
 284 extern const arch_irn_handler_t be_node_irn_handler;
 285
 286 #endif /* _BENODE_T_H */