update copyright message
[libfirm] / ir / be / TEMPLATE / TEMPLATE_new_nodes.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   This file implements the creation of the achitecture specific firm
23  *          opcodes and the coresponding node constructors for the TEMPLATE
24  *          assembler irg.
25  * @version $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdlib.h>
32
33 #include "irprog_t.h"
34 #include "irgraph_t.h"
35 #include "irnode_t.h"
36 #include "irmode_t.h"
37 #include "ircons_t.h"
38 #include "iropt_t.h"
39 #include "irop.h"
40 #include "firm_common_t.h"
41 #include "irvrfy_t.h"
42 #include "irprintf.h"
43 #include "xmalloc.h"
44
45 #include "../bearch_t.h"
46
47 #include "TEMPLATE_nodes_attr.h"
48 #include "TEMPLATE_new_nodes.h"
49 #include "gen_TEMPLATE_regalloc_if.h"
50
51
52
53 /***********************************************************************************
54  *      _                                   _       _             __
55  *     | |                                 (_)     | |           / _|
56  *   __| |_   _ _ __ ___  _ __   ___ _ __   _ _ __ | |_ ___ _ __| |_ __ _  ___ ___
57  *  / _` | | | | '_ ` _ \| '_ \ / _ \ '__| | | '_ \| __/ _ \ '__|  _/ _` |/ __/ _ \
58  * | (_| | |_| | | | | | | |_) |  __/ |    | | | | | ||  __/ |  | || (_| | (_|  __/
59  *  \__,_|\__,_|_| |_| |_| .__/ \___|_|    |_|_| |_|\__\___|_|  |_| \__,_|\___\___|
60  *                       | |
61  *                       |_|
62  ***********************************************************************************/
63
64 /**
65  * Dumps the register requirements for either in or out.
66  */
67 static void dump_reg_req(FILE *F, ir_node *n, const arch_register_req_t **reqs,
68                          int inout) {
69         char *dir = inout ? "out" : "in";
70         int   max = inout ? get_TEMPLATE_n_res(n) : get_irn_arity(n);
71         char  buf[1024];
72         int   i;
73
74         memset(buf, 0, sizeof(buf));
75
76         if (reqs) {
77                 for (i = 0; i < max; i++) {
78                         fprintf(F, "%sreq #%d =", dir, i);
79
80                         if (reqs[i]->type == arch_register_req_type_none) {
81                                 fprintf(F, " n/a");
82                         }
83
84                         if (reqs[i]->type & arch_register_req_type_normal) {
85                                 fprintf(F, " %s", reqs[i]->cls->name);
86                         }
87
88                         if (reqs[i]->type & arch_register_req_type_limited) {
89                                 fprintf(F, " %s",
90                                                 arch_register_req_format(buf, sizeof(buf), reqs[i], n));
91                         }
92
93                         if (reqs[i]->type & arch_register_req_type_should_be_same) {
94                                 const unsigned other = reqs[i]->other_same;
95                                 int i;
96
97                                 ir_fprintf(F, " same as");
98                                 for (i = 0; 1U << i <= other; ++i) {
99                                         if (other & (1U << i)) {
100                                                 ir_fprintf(F, " %+F", get_irn_n(n, i));
101                                         }
102                                 }
103                         }
104
105                         if (reqs[i]->type & arch_register_req_type_should_be_different) {
106                                 const unsigned other = reqs[i]->other_different;
107                                 int i;
108
109                                 ir_fprintf(F, " different from");
110                                 for (i = 0; 1U << i <= other; ++i) {
111                                         if (other & (1U << i)) {
112                                                 ir_fprintf(F, " %+F", get_irn_n(n, i));
113                                         }
114                                 }
115                         }
116
117                         fprintf(F, "\n");
118                 }
119
120                 fprintf(F, "\n");
121         } else {
122                 fprintf(F, "%sreq = N/A\n", dir);
123         }
124 }
125
126
127 /**
128  * Dumper interface for dumping TEMPLATE nodes in vcg.
129  * @param n        the node to dump
130  * @param F        the output file
131  * @param reason   indicates which kind of information should be dumped
132  * @return 0 on success or != 0 on failure
133  */
134 static int TEMPLATE_dump_node(ir_node *n, FILE *F, dump_reason_t reason) {
135         ir_mode     *mode = NULL;
136         int          bad  = 0;
137         int          i;
138         const TEMPLATE_attr_t *attr;
139         const arch_register_req_t **reqs;
140         const arch_register_t     **slots;
141
142         switch (reason) {
143                 case dump_node_opcode_txt:
144                         fprintf(F, "%s", get_irn_opname(n));
145                         break;
146
147                 case dump_node_mode_txt:
148                         mode = get_irn_mode(n);
149
150                         if (mode) {
151                                 fprintf(F, "[%s]", get_mode_name(mode));
152                         }
153                         else {
154                                 fprintf(F, "[?NOMODE?]");
155                         }
156                         break;
157
158                 case dump_node_nodeattr_txt:
159
160                         /* TODO: dump some attributes which should show up */
161                         /* in node name in dump (e.g. consts or the like)  */
162
163                         break;
164
165                 case dump_node_info_txt:
166                         attr = get_TEMPLATE_attr_const(n);
167                         fprintf(F, "=== TEMPLATE attr begin ===\n");
168
169                         /* dump IN requirements */
170                         if (get_irn_arity(n) > 0) {
171                                 reqs = get_TEMPLATE_in_req_all(n);
172                                 dump_reg_req(F, n, reqs, 0);
173                         }
174
175                         /* dump OUT requirements */
176                         if (ARR_LEN(attr->slots) > 0) {
177                                 reqs = get_TEMPLATE_out_req_all(n);
178                                 dump_reg_req(F, n, reqs, 1);
179                         }
180
181                         /* dump assigned registers */
182                         slots = get_TEMPLATE_slots(n);
183                         if (slots && ARR_LEN(attr->slots) > 0) {
184                                 for (i = 0; i < ARR_LEN(attr->slots); i++) {
185                                         if (slots[i]) {
186                                                 fprintf(F, "reg #%d = %s\n", i, slots[i]->name);
187                                         }
188                                         else {
189                                                 fprintf(F, "reg #%d = n/a\n", i);
190                                         }
191                                 }
192                         }
193                         fprintf(F, "\n");
194
195                         /* dump n_res */
196                         fprintf(F, "n_res = %d\n", get_TEMPLATE_n_res(n));
197
198                         /* dump flags */
199                         fprintf(F, "flags =");
200                         if (attr->flags == arch_irn_flags_none) {
201                                 fprintf(F, " none");
202                         }
203                         else {
204                                 if (attr->flags & arch_irn_flags_dont_spill) {
205                                         fprintf(F, " unspillable");
206                                 }
207                                 if (attr->flags & arch_irn_flags_rematerializable) {
208                                         fprintf(F, " remat");
209                                 }
210                                 if (attr->flags & arch_irn_flags_ignore) {
211                                         fprintf(F, " ignore");
212                                 }
213                         }
214                         fprintf(F, " (%d)\n", attr->flags);
215
216                         /* TODO: dump all additional attributes */
217
218                         fprintf(F, "=== TEMPLATE attr end ===\n");
219                         /* end of: case dump_node_info_txt */
220                         break;
221         }
222
223
224         return bad;
225 }
226
227
228
229 /***************************************************************************************************
230  *        _   _                   _       __        _                    _   _               _
231  *       | | | |                 | |     / /       | |                  | | | |             | |
232  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
233  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
234  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
235  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
236  *                                        __/ |
237  *                                       |___/
238  ***************************************************************************************************/
239
240 const TEMPLATE_attr_t *get_TEMPLATE_attr_const(const ir_node *node) {
241         assert(is_TEMPLATE_irn(node) && "need TEMPLATE node to get attributes");
242         return (const TEMPLATE_attr_t *)get_irn_generic_attr_const(node);
243 }
244
245 TEMPLATE_attr_t *get_TEMPLATE_attr(ir_node *node) {
246         assert(is_TEMPLATE_irn(node) && "need TEMPLATE node to get attributes");
247         return (TEMPLATE_attr_t *)get_irn_generic_attr(node);
248 }
249
250 /**
251  * Returns the argument register requirements of a TEMPLATE node.
252  */
253 const arch_register_req_t **get_TEMPLATE_in_req_all(const ir_node *node) {
254         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
255         return attr->in_req;
256 }
257
258 /**
259  * Returns the result register requirements of an TEMPLATE node.
260  */
261 const arch_register_req_t **get_TEMPLATE_out_req_all(const ir_node *node) {
262         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
263         return attr->out_req;
264 }
265
266 /**
267  * Returns the argument register requirement at position pos of an TEMPLATE node.
268  */
269 const arch_register_req_t *get_TEMPLATE_in_req(const ir_node *node, int pos) {
270         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
271         return attr->in_req[pos];
272 }
273
274 /**
275  * Returns the result register requirement at position pos of an TEMPLATE node.
276  */
277 const arch_register_req_t *get_TEMPLATE_out_req(const ir_node *node, int pos) {
278         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
279         return attr->out_req[pos];
280 }
281
282 /**
283  * Sets the OUT register requirements at position pos.
284  */
285 void set_TEMPLATE_req_out(ir_node *node, const arch_register_req_t *req, int pos) {
286         TEMPLATE_attr_t *attr   = get_TEMPLATE_attr(node);
287         attr->out_req[pos] = req;
288 }
289
290 /**
291  * Sets the IN register requirements at position pos.
292  */
293 void set_TEMPLATE_req_in(ir_node *node, const arch_register_req_t *req, int pos) {
294         TEMPLATE_attr_t *attr  = get_TEMPLATE_attr(node);
295         attr->in_req[pos] = req;
296 }
297
298 /**
299  * Returns the register flag of an TEMPLATE node.
300  */
301 arch_irn_flags_t get_TEMPLATE_flags(const ir_node *node) {
302         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
303         return attr->flags;
304 }
305
306 /**
307  * Sets the register flag of an TEMPLATE node.
308  */
309 void set_TEMPLATE_flags(ir_node *node, arch_irn_flags_t flags) {
310         TEMPLATE_attr_t *attr = get_TEMPLATE_attr(node);
311         attr->flags      = flags;
312 }
313
314 /**
315  * Returns the result register slots of an TEMPLATE node.
316  */
317 const arch_register_t **get_TEMPLATE_slots(ir_node *node) {
318         TEMPLATE_attr_t *attr = get_TEMPLATE_attr(node);
319         return attr->slots;
320 }
321
322 /**
323  * Returns the result register slots of an TEMPLATE node.
324  */
325 const arch_register_t * const *get_TEMPLATE_slots_const(const ir_node *node) {
326         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
327         return attr->slots;
328 }
329
330 /**
331  * Returns the name of the OUT register at position pos.
332  */
333 const char *get_TEMPLATE_out_reg_name(const ir_node *node, int pos) {
334         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
335
336         assert(is_TEMPLATE_irn(node) && "Not an TEMPLATE node.");
337         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
338         assert(attr->slots[pos]  && "No register assigned");
339
340         return arch_register_get_name(attr->slots[pos]);
341 }
342
343 /**
344  * Returns the index of the OUT register at position pos within its register class.
345  */
346 int get_TEMPLATE_out_regnr(const ir_node *node, int pos) {
347         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
348
349         assert(is_TEMPLATE_irn(node) && "Not an TEMPLATE node.");
350         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
351         assert(attr->slots[pos]  && "No register assigned");
352
353         return arch_register_get_index(attr->slots[pos]);
354 }
355
356 /**
357  * Returns the OUT register at position pos.
358  */
359 const arch_register_t *get_TEMPLATE_out_reg(const ir_node *node, int pos) {
360         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
361
362         assert(is_TEMPLATE_irn(node) && "Not an TEMPLATE node.");
363         assert(pos < ARR_LEN(attr->slots) && "Invalid OUT position.");
364         assert(attr->slots[pos]  && "No register assigned");
365
366         return attr->slots[pos];
367 }
368
369 /**
370  * Returns the number of results.
371  */
372 int get_TEMPLATE_n_res(const ir_node *node) {
373         const TEMPLATE_attr_t *attr = get_TEMPLATE_attr_const(node);
374         return ARR_LEN(attr->slots);
375 }
376
377 /**
378  * Initializes the nodes attributes.
379  */
380 void init_TEMPLATE_attributes(ir_node *node, arch_irn_flags_t flags,
381                               const arch_register_req_t **in_reqs,
382                               const arch_register_req_t **out_reqs,
383                               const be_execution_unit_t ***execution_units,
384                               int n_res)
385 {
386         ir_graph        *irg  = get_irn_irg(node);
387         struct obstack  *obst = get_irg_obstack(irg);
388         TEMPLATE_attr_t *attr = get_TEMPLATE_attr(node);
389         (void) execution_units;
390
391         attr->flags   = flags;
392         attr->out_req = out_reqs;
393         attr->in_req  = in_reqs;
394
395         attr->slots = NEW_ARR_D(const arch_register_t*, obst, n_res);
396         memset(attr->slots, 0, n_res * sizeof(attr->slots[0]));
397 }
398
399 /***************************************************************************************
400  *                  _                            _                   _
401  *                 | |                          | |                 | |
402  *  _ __   ___   __| | ___    ___ ___  _ __  ___| |_ _ __ _   _  ___| |_ ___  _ __ ___
403  * | '_ \ / _ \ / _` |/ _ \  / __/ _ \| '_ \/ __| __| '__| | | |/ __| __/ _ \| '__/ __|
404  * | | | | (_) | (_| |  __/ | (_| (_) | | | \__ \ |_| |  | |_| | (__| || (_) | |  \__ \
405  * |_| |_|\___/ \__,_|\___|  \___\___/|_| |_|___/\__|_|   \__,_|\___|\__\___/|_|  |___/
406  *
407  ***************************************************************************************/
408
409 static
410 int TEMPLATE_compare_attr(ir_node *a, ir_node *b)
411 {
412         const TEMPLATE_attr_t *attr_a = get_TEMPLATE_attr_const(a);
413         const TEMPLATE_attr_t *attr_b = get_TEMPLATE_attr_const(b);
414
415         if(attr_a->flags != attr_b->flags)
416                 return 1;
417
418         return 0;
419 }
420
421
422 /* Include the generated constructor functions */
423 #include "gen_TEMPLATE_new_nodes.c.inl"