remove unnecessary comments before functions
[libfirm] / ir / ir / irop.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Representation of opcode of intermediate operation.
23  * @author  Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  */
25 #include "config.h"
26
27 #include <string.h>
28
29 #include "irop_t.h"
30 #include "irnode_t.h"
31 #include "irhooks.h"
32 #include "irbackedge_t.h"
33
34 #include "iropt_t.h"
35 #include "irverify_t.h"
36 #include "reassoc_t.h"
37
38 #include "xmalloc.h"
39
40 void be_init_op(void);
41
42 /** the available next opcode */
43 static unsigned next_iro = iro_MaxOpcode;
44
45 void default_copy_attr(ir_graph *irg, const ir_node *old_node,
46                        ir_node *new_node)
47 {
48         unsigned size = firm_add_node_size;
49         (void) irg;
50
51         assert(get_irn_op(old_node) == get_irn_op(new_node));
52         memcpy(&new_node->attr, &old_node->attr, get_op_attr_size(get_irn_op(old_node)));
53
54         if (size > 0) {
55                 /* copy additional node data */
56                 memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
57         }
58 }
59
60 /**
61  * Copies all Call attributes stored in the old node to the new node.
62  */
63 static void call_copy_attr(ir_graph *irg, const ir_node *old_node,
64                            ir_node *new_node)
65 {
66         default_copy_attr(irg, old_node, new_node);
67         remove_Call_callee_arr(new_node);
68 }
69
70 /**
71  * Copies all Block attributes stored in the old node to the new node.
72  */
73 static void block_copy_attr(ir_graph *irg, const ir_node *old_node,
74                             ir_node *new_node)
75 {
76         default_copy_attr(irg, old_node, new_node);
77         new_node->attr.block.irg.irg       = irg;
78         new_node->attr.block.phis          = NULL;
79         new_node->attr.block.cg_backedge   = NULL;
80         new_node->attr.block.backedge      = new_backedge_arr(irg->obst, get_irn_arity(new_node));
81         new_node->attr.block.block_visited = 0;
82         memset(&new_node->attr.block.dom, 0, sizeof(new_node->attr.block.dom));
83         memset(&new_node->attr.block.pdom, 0, sizeof(new_node->attr.block.pdom));
84         /* It should be safe to copy the entity here, as it has no back-link to the old block.
85          * It serves just as a label number, so copying a labeled block results in an exact copy.
86          * This is at least what we need for DCE to work. */
87         new_node->attr.block.entity         = old_node->attr.block.entity;
88         new_node->attr.block.phis           = NULL;
89         INIT_LIST_HEAD(&new_node->attr.block.succ_head);
90 }
91
92 /**
93  * Copies all phi attributes stored in old node to the new node
94  */
95 static void phi_copy_attr(ir_graph *irg, const ir_node *old_node,
96                           ir_node *new_node)
97 {
98         default_copy_attr(irg, old_node, new_node);
99         new_node->attr.phi.next       = NULL;
100         new_node->attr.phi.u.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
101 }
102
103 /**
104  * Copies all ASM attributes stored in old node to the new node
105  */
106 static void ASM_copy_attr(ir_graph *irg, const ir_node *old_node,
107                           ir_node *new_node)
108 {
109         default_copy_attr(irg, old_node, new_node);
110         new_node->attr.assem.input_constraints  = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.input_constraints);
111         new_node->attr.assem.output_constraints = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.output_constraints);
112         new_node->attr.assem.clobbers = DUP_ARR_D(ident*, irg->obst, old_node->attr.assem.clobbers);
113 }
114
115 static void switch_copy_attr(ir_graph *irg, const ir_node *old_node,
116                              ir_node *new_node)
117 {
118         const ir_switch_table *table = get_Switch_table(old_node);
119         new_node->attr.switcha.table = ir_switch_table_duplicate(irg, table);
120         new_node->attr.switcha.n_outs = old_node->attr.switcha.n_outs;
121 }
122
123 /**
124  * Sets the default copy_attr operation for an ir_ops
125  *
126  * @param code   the opcode for the default operation
127  * @param ops    the operations initialized
128  *
129  * @return
130  *    The operations.
131  */
132 static void firm_set_default_copy_attr(unsigned code, ir_op_ops *ops)
133 {
134         switch (code) {
135         case iro_Call:   ops->copy_attr = call_copy_attr;   break;
136         case iro_Block:  ops->copy_attr = block_copy_attr;  break;
137         case iro_Phi:    ops->copy_attr = phi_copy_attr;    break;
138         case iro_ASM:    ops->copy_attr = ASM_copy_attr;    break;
139         case iro_Switch: ops->copy_attr = switch_copy_attr; break;
140         default:
141                 if (ops->copy_attr == NULL)
142                         ops->copy_attr = default_copy_attr;
143         }
144 }
145
146 /*
147  * Sets the default operation for an ir_ops.
148  */
149 static void set_default_operations(unsigned code, ir_op_ops *ops)
150 {
151         firm_set_default_hash(code, ops);
152         firm_set_default_computed_value(code, ops);
153         firm_set_default_equivalent_node(code, ops);
154         firm_set_default_transform_node(code, ops);
155         firm_set_default_node_cmp_attr(code, ops);
156         firm_set_default_get_type_attr(code, ops);
157         firm_set_default_get_entity_attr(code, ops);
158         firm_set_default_copy_attr(code, ops);
159         firm_set_default_verifier(code, ops);
160         firm_set_default_reassoc(code, ops);
161 }
162
163 ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
164                  unsigned flags, op_arity opar, int op_index, size_t attr_size,
165                  const ir_op_ops *ops)
166 {
167         ir_op *res = XMALLOCZ(ir_op);
168
169         res->code      = code;
170         res->name      = new_id_from_chars(name, strlen(name));
171         res->pin_state = p;
172         res->attr_size = attr_size;
173         res->flags     = flags;
174         res->opar      = opar;
175         res->op_index  = op_index;
176         res->tag       = 0;
177
178         if (ops)
179                 res->ops = *ops;
180         else /* no given ops, set all operations to NULL */
181                 memset(&res->ops, 0, sizeof(res->ops));
182
183         set_default_operations(code, &res->ops);
184
185         add_irp_opcode(res);
186
187         hook_new_ir_op(res);
188         return res;
189 }
190
191 void free_ir_op(ir_op *code)
192 {
193         hook_free_ir_op(code);
194
195         remove_irp_opcode(code);
196         free(code);
197 }
198
199 void ir_op_set_memory_index(ir_op *op, int memory_index)
200 {
201         assert(op->flags & irop_flag_uses_memory);
202         op->memory_index = memory_index;
203 }
204
205 void ir_op_set_fragile_indices(ir_op *op, int pn_x_regular, int pn_x_except)
206 {
207         assert(op->flags & irop_flag_fragile);
208         op->pn_x_regular = pn_x_regular;
209         op->pn_x_except = pn_x_except;
210 }
211
212 const char *get_op_name (const ir_op *op)
213 {
214         return get_id_str(op->name);
215 }
216
217 unsigned (get_op_code)(const ir_op *op)
218 {
219   return get_op_code_(op);
220 }
221
222 ident *(get_op_ident)(const ir_op *op)
223 {
224   return get_op_ident_(op);
225 }
226
227 const char *get_op_pin_state_name(op_pin_state s)
228 {
229         switch (s) {
230 #define XXX(s) case s: return #s
231         XXX(op_pin_state_floats);
232         XXX(op_pin_state_pinned);
233         XXX(op_pin_state_exc_pinned);
234         XXX(op_pin_state_mem_pinned);
235 #undef XXX
236         }
237         return "<none>";
238 }
239
240 op_pin_state (get_op_pinned)(const ir_op *op)
241 {
242         return get_op_pinned_(op);
243 }
244
245 void set_op_pinned(ir_op *op, op_pin_state pinned)
246 {
247         if (op == op_Block || op == op_Phi || is_op_cfopcode(op)) return;
248         op->pin_state = pinned;
249 }
250
251 unsigned get_next_ir_opcode(void)
252 {
253         return next_iro++;
254 }
255
256 unsigned get_next_ir_opcodes(unsigned num)
257 {
258         unsigned base = next_iro;
259         next_iro += num;
260         return base;
261 }
262
263 op_func (get_generic_function_ptr)(const ir_op *op)
264 {
265         return get_generic_function_ptr_(op);
266 }
267
268 void (set_generic_function_ptr)(ir_op *op, op_func func)
269 {
270         set_generic_function_ptr_(op, func);
271 }
272
273 const ir_op_ops *(get_op_ops)(const ir_op *op)
274 {
275         return get_op_ops_(op);
276 }
277
278 irop_flags get_op_flags(const ir_op *op)
279 {
280         return (irop_flags)op->flags;
281 }
282
283 #include "gen_irop.c.inl"