dump_node operatiomn added
[libfirm] / ir / ir / irop.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irop.c
4  * Purpose:     Representation of opcode of intermediate operation.
5  * Author:      Christian Schaefer
6  * Modified by: Goetz Lindenmaier
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 #ifdef HAVE_CONFIG_H
14 # include "config.h"
15 #endif
16
17 #ifdef HAVE_STRING_H
18 # include <string.h>
19 #endif
20
21 # include "irop_t.h"
22 # include "irnode_t.h"
23 # include "irhooks.h"
24
25 # include "iropt_t.h"             /* for firm_set_default_operations */
26 # include "irvrfy_t.h"
27 # include "reassoc_t.h"
28
29 # include "xmalloc.h"
30
31 /** the available next opcode */
32 static unsigned next_iro = iro_MaxOpcode;
33
34 ir_op *op_Block;       ir_op *get_op_Block     (void) { return op_Block;     }
35
36 ir_op *op_Start;       ir_op *get_op_Start     (void) { return op_Start;     }
37 ir_op *op_End;         ir_op *get_op_End       (void) { return op_End;       }
38 ir_op *op_Jmp;         ir_op *get_op_Jmp       (void) { return op_Jmp;       }
39 ir_op *op_IJmp;        ir_op *get_op_IJmp      (void) { return op_IJmp;      }
40 ir_op *op_Cond;        ir_op *get_op_Cond      (void) { return op_Cond;      }
41 ir_op *op_Return;      ir_op *get_op_Return    (void) { return op_Return;    }
42 ir_op *op_Raise;       ir_op *get_op_Raise     (void) { return op_Raise;     }
43
44 ir_op *op_Sel;         ir_op *get_op_Sel       (void) { return op_Sel;       }
45 ir_op *op_InstOf;      ir_op *get_op_InstOf    (void) { return op_InstOf;    }
46
47 ir_op *op_Const;       ir_op *get_op_Const     (void) { return op_Const;     }
48 ir_op *op_SymConst;    ir_op *get_op_SymConst  (void) { return op_SymConst;  }
49
50 ir_op *op_Call;        ir_op *get_op_Call      (void) { return op_Call;      }
51 ir_op *op_Add;         ir_op *get_op_Add       (void) { return op_Add;       }
52 ir_op *op_Sub;         ir_op *get_op_Sub       (void) { return op_Sub;       }
53 ir_op *op_Minus;       ir_op *get_op_Minus     (void) { return op_Minus;     }
54 ir_op *op_Mul;         ir_op *get_op_Mul       (void) { return op_Mul;       }
55 ir_op *op_Quot;        ir_op *get_op_Quot      (void) { return op_Quot;      }
56 ir_op *op_DivMod;      ir_op *get_op_DivMod    (void) { return op_DivMod;    }
57 ir_op *op_Div;         ir_op *get_op_Div       (void) { return op_Div;       }
58 ir_op *op_Mod;         ir_op *get_op_Mod       (void) { return op_Mod;       }
59 ir_op *op_Abs;         ir_op *get_op_Abs       (void) { return op_Abs;       }
60 ir_op *op_And;         ir_op *get_op_And       (void) { return op_And;       }
61 ir_op *op_Or;          ir_op *get_op_Or        (void) { return op_Or;        }
62 ir_op *op_Eor;         ir_op *get_op_Eor       (void) { return op_Eor;       }
63 ir_op *op_Not;         ir_op *get_op_Not       (void) { return op_Not;       }
64 ir_op *op_Cmp;         ir_op *get_op_Cmp       (void) { return op_Cmp;       }
65 ir_op *op_Shl;         ir_op *get_op_Shl       (void) { return op_Shl;       }
66 ir_op *op_Shr;         ir_op *get_op_Shr       (void) { return op_Shr;       }
67 ir_op *op_Shrs;        ir_op *get_op_Shrs      (void) { return op_Shrs;      }
68 ir_op *op_Rot;         ir_op *get_op_Rot       (void) { return op_Rot;       }
69 ir_op *op_Conv;        ir_op *get_op_Conv      (void) { return op_Conv;      }
70 ir_op *op_Cast;        ir_op *get_op_Cast      (void) { return op_Cast;      }
71
72 ir_op *op_Phi;         ir_op *get_op_Phi       (void) { return op_Phi;       }
73
74 ir_op *op_Load;        ir_op *get_op_Load      (void) { return op_Load;      }
75 ir_op *op_Store;       ir_op *get_op_Store     (void) { return op_Store;     }
76 ir_op *op_Alloc;       ir_op *get_op_Alloc     (void) { return op_Alloc;     }
77 ir_op *op_Free;        ir_op *get_op_Free      (void) { return op_Free;      }
78 ir_op *op_Sync;        ir_op *get_op_Sync      (void) { return op_Sync;      }
79
80 ir_op *op_Tuple;       ir_op *get_op_Tuple     (void) { return op_Tuple;     }
81 ir_op *op_Proj;        ir_op *get_op_Proj      (void) { return op_Proj;      }
82 ir_op *op_Id;          ir_op *get_op_Id        (void) { return op_Id;        }
83 ir_op *op_Bad;         ir_op *get_op_Bad       (void) { return op_Bad;       }
84 ir_op *op_Confirm;     ir_op *get_op_Confirm   (void) { return op_Confirm;   }
85
86 ir_op *op_Unknown;     ir_op *get_op_Unknown   (void) { return op_Unknown;   }
87 ir_op *op_Filter;      ir_op *get_op_Filter    (void) { return op_Filter;    }
88 ir_op *op_Break;       ir_op *get_op_Break     (void) { return op_Break;     }
89 ir_op *op_CallBegin;   ir_op *get_op_CallBegin (void) { return op_CallBegin; }
90 ir_op *op_EndReg;      ir_op *get_op_EndReg    (void) { return op_EndReg;    }
91 ir_op *op_EndExcept;   ir_op *get_op_EndExcept (void) { return op_EndExcept; }
92
93 ir_op *op_NoMem;       ir_op *get_op_NoMem     (void) { return op_NoMem;     }
94 ir_op *op_Mux;         ir_op *get_op_Mux       (void) { return op_Mux;       }
95 ir_op *op_CopyB;       ir_op *get_op_CopyB     (void) { return op_CopyB;     }
96
97
98 /*
99  * Copies all attributes stored in the old node to the new node.
100  * Assumes both have the same opcode and sufficient size.
101  */
102 void default_copy_attr(const ir_node *old_node, ir_node *new_node) {
103   unsigned size = firm_add_node_size;
104
105   assert(get_irn_op(old_node) == get_irn_op(new_node));
106   memcpy(&new_node->attr, &old_node->attr, get_op_attr_size(get_irn_op(old_node)));
107
108   if (size > 0) {
109     /* copy additional node data */
110     memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
111   }
112 }
113
114 /**
115  * Copies all attributes stored in the old node to the new node.
116  * Assumes both have the same opcode and sufficient size.
117  */
118 static void
119 call_copy_attr(const ir_node *old_node, ir_node *new_node) {
120   default_copy_attr(old_node, new_node);
121
122   remove_Call_callee_arr(new_node);
123 }
124
125 static void
126 block_copy_attr(const ir_node *old_node, ir_node *new_node)
127 {
128   default_copy_attr(old_node, new_node);
129   INIT_LIST_HEAD(&new_node->attr.block.succ_head);
130 }
131
132 /**
133  * Sets the default copy_attr operation for an ir_ops
134  *
135  * @param code   the opcode for the default operation
136  * @param ops    the operations initialized
137  *
138  * @return
139  *    The operations.
140  */
141 static ir_op_ops *firm_set_default_copy_attr(opcode code, ir_op_ops *ops) {
142   if (code == iro_Call)
143     ops->copy_attr = call_copy_attr;
144   else if (code == iro_Block)
145     ops->copy_attr = block_copy_attr;
146   else {
147     /* not allowed to be NULL */
148     if (! ops->copy_attr)
149       ops->copy_attr = default_copy_attr;
150   }
151
152   return ops;
153 }
154
155 /* Creates a new ir operation. */
156 ir_op *
157 new_ir_op(opcode code, const char *name, op_pin_state p,
158           unsigned flags, op_arity opar, int op_index, size_t attr_size,
159           const ir_op_ops *ops)
160 {
161   ir_op *res;
162
163   res = (ir_op *)xmalloc(sizeof(*res));
164   memset(res, 0, sizeof(*res));
165
166   res->code      = code;
167   res->name      = new_id_from_chars(name, strlen(name));
168   res->op_pin_state_pinned = p;
169   res->attr_size = attr_size;
170   res->flags     = flags;
171   res->opar      = opar;
172   res->op_index  = op_index;
173
174   if (ops)
175     memcpy(&res->ops, ops, sizeof(res->ops));
176   else /* no given ops, set all operations to NULL */
177     memset(&res->ops, 0, sizeof(res->ops));
178
179   firm_set_default_operations(code, &res->ops);
180   firm_set_default_copy_attr(code, &res->ops);
181   firm_set_default_verifyer(code, &res->ops);
182   firm_set_default_reassoc(code, &res->ops);
183
184   hook_new_ir_op(res);
185   return res;
186 }
187
188 void free_ir_op(ir_op *code) {
189   hook_free_ir_op(code);
190   free(code);
191 }
192
193 void
194 init_op(void)
195 {
196 #define N   irop_flag_none
197 #define L   irop_flag_labeled
198 #define C   irop_flag_commutative
199 #define X   irop_flag_cfopcode
200 #define I   irop_flag_ip_cfopcode
201 #define F   irop_flag_fragile
202 #define Y   irop_flag_forking
203 #define H   irop_flag_highlevel
204 #define c   irop_flag_constlike
205
206   op_Block     = new_ir_op(iro_Block,     "Block",     op_pin_state_pinned, L,       oparity_variable, -1, sizeof(block_attr), NULL);
207
208   op_Start     = new_ir_op(iro_Start,     "Start",     op_pin_state_pinned, X,       oparity_zero,     -1, sizeof(start_attr), NULL);
209   op_End       = new_ir_op(iro_End,       "End",       op_pin_state_pinned, X,       oparity_dynamic,  -1, 0, NULL);
210   op_Jmp       = new_ir_op(iro_Jmp,       "Jmp",       op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
211   op_IJmp      = new_ir_op(iro_IJmp,      "IJmp",      op_pin_state_pinned, X,       oparity_unary,    -1, 0, NULL);
212   op_Cond      = new_ir_op(iro_Cond,      "Cond",      op_pin_state_pinned, L|X|Y,   oparity_any,      -1, sizeof(cond_attr), NULL);
213   op_Return    = new_ir_op(iro_Return,    "Return",    op_pin_state_pinned, L|X,     oparity_zero,     -1, 0, NULL);
214   op_Raise     = new_ir_op(iro_Raise,     "Raise",     op_pin_state_pinned, L|X,     oparity_any,      -1, 0, NULL);
215
216   op_Const     = new_ir_op(iro_Const,     "Const",     op_pin_state_floats, c,       oparity_zero,     -1, sizeof(const_attr), NULL);
217   op_SymConst  = new_ir_op(iro_SymConst,  "SymConst",  op_pin_state_floats, c,       oparity_zero,     -1, sizeof(symconst_attr), NULL);
218
219   op_Sel       = new_ir_op(iro_Sel,       "Sel",       op_pin_state_floats, L,       oparity_any,      -1, sizeof(sel_attr), NULL);
220   op_InstOf    = new_ir_op(iro_InstOf,    "InstOf",    op_pin_state_floats, L,       oparity_any,      -1, sizeof(sel_attr), NULL);
221
222   op_Call      = new_ir_op(iro_Call,      "Call",      op_pin_state_mem_pinned, L|F, oparity_variable, -1, sizeof(call_attr), NULL);
223   op_Add       = new_ir_op(iro_Add,       "Add",       op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
224   op_Minus     = new_ir_op(iro_Minus,     "Minus",     op_pin_state_floats, N,       oparity_unary,     0, 0, NULL);
225   op_Sub       = new_ir_op(iro_Sub,       "Sub",       op_pin_state_floats, N,       oparity_binary,    0, 0, NULL);
226   op_Mul       = new_ir_op(iro_Mul,       "Mul",       op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
227   op_Quot      = new_ir_op(iro_Quot,      "Quot",      op_pin_state_exc_pinned, L|F, oparity_binary,    1, sizeof(except_attr), NULL);
228   op_DivMod    = new_ir_op(iro_DivMod,    "DivMod",    op_pin_state_exc_pinned, L|F, oparity_binary,    1, sizeof(except_attr), NULL);
229   op_Div       = new_ir_op(iro_Div,       "Div",       op_pin_state_exc_pinned, L|F, oparity_binary,    1, sizeof(except_attr), NULL);
230   op_Mod       = new_ir_op(iro_Mod,       "Mod",       op_pin_state_exc_pinned, L|F, oparity_binary,    1, sizeof(except_attr), NULL);
231   op_Abs       = new_ir_op(iro_Abs,       "Abs",       op_pin_state_floats, N,       oparity_unary,     0, 0, NULL);
232   op_And       = new_ir_op(iro_And,       "And",       op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
233   op_Or        = new_ir_op(iro_Or,        "Or",        op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
234   op_Eor       = new_ir_op(iro_Eor,       "Eor",       op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
235   op_Not       = new_ir_op(iro_Not,       "Not",       op_pin_state_floats, N,       oparity_unary,     0, 0, NULL);
236   op_Cmp       = new_ir_op(iro_Cmp,       "Cmp",       op_pin_state_floats, L,       oparity_binary,    0, 0, NULL);
237   op_Shl       = new_ir_op(iro_Shl,       "Shl",       op_pin_state_floats, L,       oparity_binary,    0, 0, NULL);
238   op_Shr       = new_ir_op(iro_Shr,       "Shr",       op_pin_state_floats, L,       oparity_binary,    0, 0, NULL);
239   op_Shrs      = new_ir_op(iro_Shrs,      "Shrs",      op_pin_state_floats, L,       oparity_binary,    0, 0, NULL);
240   op_Rot       = new_ir_op(iro_Rot,       "Rot",       op_pin_state_floats, L,       oparity_binary,    0, 0, NULL);
241   op_Conv      = new_ir_op(iro_Conv,      "Conv",      op_pin_state_floats, N,       oparity_unary,     0, 0, NULL);
242   op_Cast      = new_ir_op(iro_Cast,      "Cast",      op_pin_state_floats, N|H,     oparity_unary,     0, sizeof(cast_attr), NULL);
243
244   op_Phi       = new_ir_op(iro_Phi,       "Phi",       op_pin_state_pinned, L,       oparity_variable, -1, sizeof(int), NULL);
245
246   op_Load      = new_ir_op(iro_Load,      "Load",      op_pin_state_exc_pinned, L|F, oparity_any,      -1, sizeof(load_attr), NULL);
247   op_Store     = new_ir_op(iro_Store,     "Store",     op_pin_state_exc_pinned, L|F, oparity_any,      -1, sizeof(store_attr), NULL);
248   op_Alloc     = new_ir_op(iro_Alloc,     "Alloc",     op_pin_state_pinned, L|F,     oparity_any,      -1, sizeof(alloc_attr), NULL);
249   op_Free      = new_ir_op(iro_Free,      "Free",      op_pin_state_pinned, L,       oparity_any,      -1, sizeof(free_attr), NULL);
250   op_Sync      = new_ir_op(iro_Sync,      "Sync",      op_pin_state_pinned, N,       oparity_any,      -1, 0, NULL);
251
252   op_Proj      = new_ir_op(iro_Proj,      "Proj",      op_pin_state_floats, N,       oparity_any,      -1, sizeof(long), NULL);
253   op_Tuple     = new_ir_op(iro_Tuple,     "Tuple",     op_pin_state_floats, L,       oparity_variable, -1, 0, NULL);
254   op_Id        = new_ir_op(iro_Id,        "Id",        op_pin_state_floats, N,       oparity_any,      -1, 0, NULL);
255   op_Bad       = new_ir_op(iro_Bad,       "Bad",       op_pin_state_pinned, X|F,     oparity_zero,     -1, 0, NULL);
256   op_Confirm   = new_ir_op(iro_Confirm,   "Confirm",   op_pin_state_floats, L|H,     oparity_any,      -1, sizeof(confirm_attr), NULL);
257
258   op_Unknown   = new_ir_op(iro_Unknown,   "Unknown",   op_pin_state_pinned, X|F,     oparity_zero,     -1, 0, NULL);
259   op_Filter    = new_ir_op(iro_Filter,    "Filter",    op_pin_state_pinned, L,       oparity_variable, -1, sizeof(filter_attr), NULL);
260   op_Break     = new_ir_op(iro_Break,     "Break",     op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
261   op_CallBegin = new_ir_op(iro_CallBegin, "CallBegin", op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(callbegin_attr), NULL);
262   op_EndReg    = new_ir_op(iro_EndReg,    "EndReg",    op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(end_attr), NULL);
263   op_EndExcept = new_ir_op(iro_EndExcept, "EndExcept", op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(end_attr), NULL);
264
265   op_NoMem     = new_ir_op(iro_NoMem,     "NoMem",     op_pin_state_pinned, N,       oparity_zero,     -1, 0, NULL);
266   op_Mux       = new_ir_op(iro_Mux,       "Mux",       op_pin_state_floats, N,       oparity_trinary,  -1, 0, NULL);
267   op_CopyB     = new_ir_op(iro_CopyB,     "CopyB",   op_pin_state_mem_pinned, L|F|H, oparity_trinary,  -1, sizeof(copyb_attr), NULL);
268
269 #undef H
270 #undef Y
271 #undef F
272 #undef I
273 #undef X
274 #undef C
275 #undef L
276 }
277
278
279 /* free memory used by irop module. */
280 void finish_op(void) {
281   free_ir_op (op_Block    ); op_Block     = NULL;
282
283   free_ir_op (op_Start    ); op_Start     = NULL;
284   free_ir_op (op_End      ); op_End       = NULL;
285   free_ir_op (op_Jmp      ); op_Jmp       = NULL;
286   free_ir_op (op_Cond     ); op_Cond      = NULL;
287   free_ir_op (op_Return   ); op_Return    = NULL;
288   free_ir_op (op_Raise    ); op_Raise     = NULL;
289
290   free_ir_op (op_Const    ); op_Const     = NULL;
291   free_ir_op (op_SymConst ); op_SymConst  = NULL;
292
293   free_ir_op (op_Sel      ); op_Sel       = NULL;
294   free_ir_op (op_InstOf   ); op_InstOf    = NULL;
295
296   free_ir_op (op_Call     ); op_Call      = NULL;
297   free_ir_op (op_Add      ); op_Add       = NULL;
298   free_ir_op (op_Minus    ); op_Minus     = NULL;
299   free_ir_op (op_Sub      ); op_Sub       = NULL;
300   free_ir_op (op_Mul      ); op_Mul       = NULL;
301   free_ir_op (op_Quot     ); op_Quot      = NULL;
302   free_ir_op (op_DivMod   ); op_DivMod    = NULL;
303   free_ir_op (op_Div      ); op_Div       = NULL;
304   free_ir_op (op_Mod      ); op_Mod       = NULL;
305   free_ir_op (op_Abs      ); op_Abs       = NULL;
306   free_ir_op (op_And      ); op_And       = NULL;
307   free_ir_op (op_Or       ); op_Or        = NULL;
308   free_ir_op (op_Eor      ); op_Eor       = NULL;
309   free_ir_op (op_Not      ); op_Not       = NULL;
310   free_ir_op (op_Cmp      ); op_Cmp       = NULL;
311   free_ir_op (op_Shl      ); op_Shl       = NULL;
312   free_ir_op (op_Shr      ); op_Shr       = NULL;
313   free_ir_op (op_Shrs     ); op_Shrs      = NULL;
314   free_ir_op (op_Rot      ); op_Rot       = NULL;
315   free_ir_op (op_Conv     ); op_Conv      = NULL;
316   free_ir_op (op_Cast     ); op_Cast      = NULL;
317
318   free_ir_op (op_Phi      ); op_Phi       = NULL;
319
320   free_ir_op (op_Load     ); op_Load      = NULL;
321   free_ir_op (op_Store    ); op_Store     = NULL;
322   free_ir_op (op_Alloc    ); op_Alloc     = NULL;
323   free_ir_op (op_Free     ); op_Free      = NULL;
324   free_ir_op (op_Sync     ); op_Sync      = NULL;
325
326   free_ir_op (op_Proj     ); op_Proj      = NULL;
327   free_ir_op (op_Tuple    ); op_Tuple     = NULL;
328   free_ir_op (op_Id       ); op_Id        = NULL;
329   free_ir_op (op_Bad      ); op_Bad       = NULL;
330   free_ir_op (op_Confirm  ); op_Confirm   = NULL;
331
332   free_ir_op (op_Unknown  ); op_Unknown   = NULL;
333   free_ir_op (op_Filter   ); op_Filter    = NULL;
334   free_ir_op (op_Break    ); op_Break     = NULL;
335   free_ir_op (op_CallBegin); op_CallBegin = NULL;
336   free_ir_op (op_EndReg   ); op_EndReg    = NULL;
337   free_ir_op (op_EndExcept); op_EndExcept = NULL;
338
339   free_ir_op (op_NoMem    ); op_NoMem     = NULL;
340   free_ir_op (op_Mux      ); op_Mux       = NULL;
341   free_ir_op (op_CopyB    ); op_CopyB     = NULL;
342 }
343
344 /* Returns the string for the opcode. */
345 const char *get_op_name (const ir_op *op) {
346   return get_id_str(op->name);
347 }
348
349 opcode (get_op_code)(const ir_op *op){
350   return _get_op_code(op);
351 }
352
353 ident *(get_op_ident)(const ir_op *op){
354   return _get_op_ident(op);
355 }
356
357 const char *get_op_pin_state_name(op_pin_state s) {
358   switch(s) {
359 #define XXX(s) case s: return #s
360   XXX(op_pin_state_floats);
361   XXX(op_pin_state_pinned);
362   XXX(op_pin_state_exc_pinned);
363   XXX(op_pin_state_mem_pinned);
364 #undef XXX
365   }
366         return "<none>";
367 }
368
369 op_pin_state (get_op_pinned)(const ir_op *op) {
370   return _get_op_pinned(op);
371 }
372
373 /* Sets op_pin_state_pinned in the opcode.  Setting it to floating has no effect
374    for Phi, Block and control flow nodes. */
375 void      set_op_pinned(ir_op *op, op_pin_state op_pin_state_pinned) {
376   if (op == op_Block || op == op_Phi || is_cfopcode(op)) return;
377   op->op_pin_state_pinned = op_pin_state_pinned;
378 }
379
380 /* retrieve the next free opcode */
381 unsigned get_next_ir_opcode(void) {
382   return next_iro++;
383 }
384
385 /* Returns the generic function pointer from an ir operation. */
386 op_func (get_generic_function_ptr)(const ir_op *op) {
387   return _get_generic_function_ptr(op);
388 }
389
390 /* Store a generic function pointer into an ir operation. */
391 void (set_generic_function_ptr)(ir_op *op, op_func func) {
392   _set_generic_function_ptr(op, func);
393 }
394
395 /* Returns the ir_op_ops of an ir_op. */
396 const ir_op_ops *(get_op_ops)(const ir_op *op) {
397   return _get_op_ops(op);
398 }