avoid _ prefix in identifiers, correct coding style
[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  * @version $Id$
25  */
26 #include "config.h"
27
28 #include <string.h>
29
30 #include "irop_t.h"
31 #include "irnode_t.h"
32 #include "irhooks.h"
33 #include "irbackedge_t.h"
34
35 #include "iropt_t.h"
36 #include "irverify_t.h"
37 #include "reassoc_t.h"
38
39 #include "xmalloc.h"
40
41 void be_init_op(void);
42
43 /** the available next opcode */
44 static unsigned next_iro = iro_MaxOpcode;
45
46 /*
47  * Copies all attributes stored in the old node to the new node.
48  * Assumes both have the same opcode and sufficient size.
49  */
50 void default_copy_attr(ir_graph *irg, const ir_node *old_node,
51                        ir_node *new_node)
52 {
53         unsigned size = firm_add_node_size;
54         (void) irg;
55
56         assert(get_irn_op(old_node) == get_irn_op(new_node));
57         memcpy(&new_node->attr, &old_node->attr, get_op_attr_size(get_irn_op(old_node)));
58
59         if (size > 0) {
60                 /* copy additional node data */
61                 memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
62         }
63 }
64
65 /**
66  * Copies all Call attributes stored in the old node to the new node.
67  */
68 static void call_copy_attr(ir_graph *irg, const ir_node *old_node,
69                            ir_node *new_node)
70 {
71         default_copy_attr(irg, old_node, new_node);
72         remove_Call_callee_arr(new_node);
73 }
74
75 /**
76  * Copies all Block attributes stored in the old node to the new node.
77  */
78 static void block_copy_attr(ir_graph *irg, const ir_node *old_node,
79                             ir_node *new_node)
80 {
81         default_copy_attr(irg, old_node, new_node);
82         new_node->attr.block.irg.irg       = irg;
83         new_node->attr.block.phis          = NULL;
84         new_node->attr.block.cg_backedge   = NULL;
85         new_node->attr.block.backedge      = new_backedge_arr(irg->obst, get_irn_arity(new_node));
86         new_node->attr.block.block_visited = 0;
87         memset(&new_node->attr.block.dom, 0, sizeof(new_node->attr.block.dom));
88         memset(&new_node->attr.block.pdom, 0, sizeof(new_node->attr.block.pdom));
89         /* It should be safe to copy the entity here, as it has no back-link to the old block.
90          * It serves just as a label number, so copying a labeled block results in an exact copy.
91          * This is at least what we need for DCE to work. */
92         new_node->attr.block.entity         = old_node->attr.block.entity;
93         new_node->attr.block.phis           = NULL;
94         INIT_LIST_HEAD(&new_node->attr.block.succ_head);
95 }
96
97 /**
98  * Copies all phi attributes stored in old node to the new node
99  */
100 static void phi_copy_attr(ir_graph *irg, const ir_node *old_node,
101                           ir_node *new_node)
102 {
103         default_copy_attr(irg, old_node, new_node);
104         new_node->attr.phi.next       = NULL;
105         new_node->attr.phi.u.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
106 }
107
108 /**
109  * Copies all ASM attributes stored in old node to the new node
110  */
111 static void ASM_copy_attr(ir_graph *irg, const ir_node *old_node,
112                           ir_node *new_node)
113 {
114         default_copy_attr(irg, old_node, new_node);
115         new_node->attr.assem.input_constraints  = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.input_constraints);
116         new_node->attr.assem.output_constraints = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.output_constraints);
117         new_node->attr.assem.clobbers = DUP_ARR_D(ident*, irg->obst, old_node->attr.assem.clobbers);
118 }
119
120 /**
121  * Sets the default copy_attr operation for an ir_ops
122  *
123  * @param code   the opcode for the default operation
124  * @param ops    the operations initialized
125  *
126  * @return
127  *    The operations.
128  */
129 static ir_op_ops *firm_set_default_copy_attr(unsigned code, ir_op_ops *ops)
130 {
131         switch (code) {
132         case iro_Call:
133                 ops->copy_attr = call_copy_attr;
134                 break;
135         case iro_Block:
136                 ops->copy_attr = block_copy_attr;
137                 break;
138         case iro_Phi:
139                 ops->copy_attr = phi_copy_attr;
140                 break;
141         case iro_ASM:
142                 ops->copy_attr = ASM_copy_attr;
143                 break;
144         default:
145                 /* not allowed to be NULL */
146                 if (! ops->copy_attr)
147                         ops->copy_attr = default_copy_attr;
148         }
149         return ops;
150 }
151
152 /* Creates a new ir operation. */
153 ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
154                  unsigned flags, op_arity opar, int op_index, size_t attr_size,
155                  const ir_op_ops *ops)
156 {
157         ir_op *res = XMALLOCZ(ir_op);
158
159         res->code      = code;
160         res->name      = new_id_from_chars(name, strlen(name));
161         res->pin_state = p;
162         res->attr_size = attr_size;
163         res->flags     = flags;
164         res->opar      = opar;
165         res->op_index  = op_index;
166         res->tag       = 0;
167
168         if (ops)
169                 res->ops = *ops;
170         else /* no given ops, set all operations to NULL */
171                 memset(&res->ops, 0, sizeof(res->ops));
172
173         firm_set_default_operations(code, &res->ops);
174         firm_set_default_copy_attr(code, &res->ops);
175         firm_set_default_verifier(code, &res->ops);
176         firm_set_default_reassoc(code, &res->ops);
177
178         add_irp_opcode(res);
179
180         hook_new_ir_op(res);
181         return res;
182 }
183
184 void free_ir_op(ir_op *code)
185 {
186         hook_free_ir_op(code);
187
188         remove_irp_opcode(code);
189         free(code);
190 }
191
192 void ir_op_set_fragile_indices(ir_op *op, int fragile_mem_index,
193                                int pn_x_regular, int pn_x_except)
194 {
195         op->fragile_mem_index = fragile_mem_index;
196         op->pn_x_regular = pn_x_regular;
197         op->pn_x_except = pn_x_except;
198 }
199
200 /* Returns the string for the opcode. */
201 const char *get_op_name (const ir_op *op)
202 {
203         return get_id_str(op->name);
204 }
205
206 unsigned (get_op_code)(const ir_op *op)
207 {
208   return get_op_code_(op);
209 }
210
211 ident *(get_op_ident)(const ir_op *op)
212 {
213   return get_op_ident_(op);
214 }
215
216 const char *get_op_pin_state_name(op_pin_state s)
217 {
218         switch (s) {
219 #define XXX(s) case s: return #s
220         XXX(op_pin_state_floats);
221         XXX(op_pin_state_pinned);
222         XXX(op_pin_state_exc_pinned);
223         XXX(op_pin_state_mem_pinned);
224 #undef XXX
225         }
226         return "<none>";
227 }
228
229 op_pin_state (get_op_pinned)(const ir_op *op)
230 {
231         return get_op_pinned_(op);
232 }
233
234 /* Sets op_pin_state_pinned in the opcode.  Setting it to floating has no effect
235    for Phi, Block and control flow nodes. */
236 void set_op_pinned(ir_op *op, op_pin_state pinned)
237 {
238         if (op == op_Block || op == op_Phi || is_op_cfopcode(op)) return;
239         op->pin_state = pinned;
240 }
241
242 /* retrieve the next free opcode */
243 unsigned get_next_ir_opcode(void)
244 {
245         return next_iro++;
246 }
247
248 /* Returns the next free n IR opcode number, allows to register a bunch of user ops */
249 unsigned get_next_ir_opcodes(unsigned num)
250 {
251         unsigned base = next_iro;
252         next_iro += num;
253         return base;
254 }
255
256 /* Returns the generic function pointer from an ir operation. */
257 op_func (get_generic_function_ptr)(const ir_op *op)
258 {
259         return get_generic_function_ptr_(op);
260 }
261
262 /* Store a generic function pointer into an ir operation. */
263 void (set_generic_function_ptr)(ir_op *op, op_func func)
264 {
265         set_generic_function_ptr_(op, func);
266 }
267
268 /* Returns the ir_op_ops of an ir_op. */
269 const ir_op_ops *(get_op_ops)(const ir_op *op)
270 {
271         return get_op_ops_(op);
272 }
273
274 irop_flags get_op_flags(const ir_op *op)
275 {
276         return (irop_flags)op->flags;
277 }
278
279 #include "gen_irop.c.inl"