Make warning about registers assigned to Phi inputs more clear.
[libfirm] / ir / be / ia32 / ia32_new_nodes.h
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       Handling of ia32 specific firm opcodes.
23  * @author      Christian Wuerdig
24  * @version     $Id$
25  *
26  * This file implements the creation of the achitecture specific firm opcodes
27  * and the coresponding node constructors for the ia32 assembler irg.
28  */
29 #ifndef FIRM_BE_IA32_IA32_NEW_NODES_H
30 #define FIRM_BE_IA32_IA32_NEW_NODES_H
31
32 #include "firm_config.h"
33 #include "ia32_nodes_attr.h"
34
35 /** indices for AM inputs */
36 enum {
37         n_ia32_base         = 0,
38         n_ia32_index        = 1,
39         n_ia32_mem          = 2,
40         n_ia32_unary_op     = 3,
41         n_ia32_binary_left  = 3,
42         n_ia32_binary_right = 4
43 };
44
45 /** proj numbers for "normal" one-result nodes (for the complicated cases where we not only
46  * need the result) */
47 enum {
48         pn_ia32_res   = 0,
49         pn_ia32_flags = 1,
50         pn_ia32_mem   = 2,
51         pn_ia32_add1  = 3,
52         pn_ia32_add2  = 4
53 };
54
55 /***************************************************************************************************
56  *        _   _                   _       __        _                    _   _               _
57  *       | | | |                 | |     / /       | |                  | | | |             | |
58  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
59  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
60  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
61  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
62  *                                        __/ |
63  *                                       |___/
64  ***************************************************************************************************/
65
66 /**
67  * returns true if a node has x87 registers
68  */
69 int ia32_has_x87_register(const ir_node *n);
70
71 /**
72  * Returns the attributes of an ia32 node.
73  */
74 ia32_attr_t *get_ia32_attr(ir_node *node);
75 const ia32_attr_t *get_ia32_attr_const(const ir_node *node);
76
77 ia32_x87_attr_t *get_ia32_x87_attr(ir_node *node);
78 const ia32_x87_attr_t *get_ia32_x87_attr_const(const ir_node *node);
79
80 ia32_immediate_attr_t *get_ia32_immediate_attr(ir_node *node);
81 const ia32_immediate_attr_t *get_ia32_immediate_attr_const(const ir_node *node);
82
83 /**
84  * Gets the condcode attributes of a node.
85  */
86 ia32_condcode_attr_t *get_ia32_condcode_attr(ir_node *node);
87 const ia32_condcode_attr_t *get_ia32_condcode_attr_const(const ir_node *node);
88
89 /**
90  * Gets the CopyB node attributes.
91  */
92 ia32_copyb_attr_t *get_ia32_copyb_attr(ir_node *node);
93 const ia32_copyb_attr_t *get_ia32_copyb_attr_const(const ir_node *node);
94
95 /**
96  * Gets the type of an ia32 node.
97  */
98 ia32_op_type_t get_ia32_op_type(const ir_node *node);
99
100 /**
101  * Sets the type of an ia32 node.
102  */
103 void set_ia32_op_type(ir_node *node, ia32_op_type_t tp);
104
105 /**
106  * Gets the supported addrmode of an ia32 node
107  */
108 ia32_am_type_t get_ia32_am_support(const ir_node *node);
109
110 ia32_am_arity_t get_ia32_am_arity(const ir_node *node);
111
112 /**
113  * Sets the supported addrmode of an ia32 node
114  */
115 void set_ia32_am_support(ir_node *node, ia32_am_type_t am_tp,
116                          ia32_am_arity_t am_arity);
117
118 /**
119  * Gets the addressmode offset as long.
120  */
121 int get_ia32_am_offs_int(const ir_node *node);
122
123 /**
124  * Sets the addressmode offset
125  */
126 void set_ia32_am_offs_int(ir_node *node, int offset);
127
128 void add_ia32_am_offs_int(ir_node *node, int offset);
129
130 /**
131  * Returns the symconst entity associated to addrmode.
132  */
133 ir_entity *get_ia32_am_sc(const ir_node *node);
134
135 /**
136  * Sets the symconst entity associated to addrmode.
137  */
138 void set_ia32_am_sc(ir_node *node, ir_entity *sc);
139
140 /**
141  * Sets the sign bit for address mode symconst.
142  */
143 void set_ia32_am_sc_sign(ir_node *node);
144
145 /**
146  * Clears the sign bit for address mode symconst.
147  */
148 void clear_ia32_am_sc_sign(ir_node *node);
149
150 /**
151  * Returns the sign bit for address mode symconst.
152  */
153 int is_ia32_am_sc_sign(const ir_node *node);
154
155 /**
156  * Gets the addr mode const.
157  */
158 int get_ia32_am_scale(const ir_node *node);
159
160 /**
161  * Sets the const for addr mode.
162  */
163 void set_ia32_am_scale(ir_node *node, int scale);
164
165 /**
166  * Sets the uses_frame flag.
167  */
168 void set_ia32_use_frame(ir_node *node);
169
170 /**
171  * Clears the uses_frame flag.
172  */
173 void clear_ia32_use_frame(ir_node *node);
174
175 /**
176  * Gets the uses_frame flag.
177  */
178 int is_ia32_use_frame(const ir_node *node);
179
180 /**
181  * copies all address-mode attributes from one node to the other
182  */
183 void ia32_copy_am_attrs(ir_node *to, const ir_node *from);
184
185 /**
186  * Sets node to commutative.
187  */
188 void set_ia32_commutative(ir_node *node);
189
190 /**
191  * Sets node to non-commutative.
192  */
193 void clear_ia32_commutative(ir_node *node);
194
195 /**
196  * Checks if node is commutative.
197  */
198 int is_ia32_commutative(const ir_node *node);
199
200 /**
201  * Sets node needs_stackent
202  */
203 void set_ia32_need_stackent(ir_node *node);
204
205 /**
206  * Clears node needs_stackent
207  */
208 void clear_ia32_need_stackent(ir_node *node);
209
210 /**
211  * Checks if node needs a stack entity assigned
212  */
213 int is_ia32_need_stackent(const ir_node *node);
214
215 void set_ia32_is_reload(ir_node *node);
216 int is_ia32_is_reload(const ir_node *node);
217
218 /**
219  * Gets the mode of the stored/loaded value (only set for Store/Load)
220  */
221 ir_mode *get_ia32_ls_mode(const ir_node *node);
222
223 /**
224  * Sets the mode of the stored/loaded value (only set for Store/Load)
225  */
226 void set_ia32_ls_mode(ir_node *node, ir_mode *mode);
227
228 /**
229  * Gets the frame entity assigned to this node;
230  */
231 ir_entity *get_ia32_frame_ent(const ir_node *node);
232
233 /**
234  * Sets the frame entity for this node;
235  */
236 void set_ia32_frame_ent(ir_node *node, ir_entity *ent);
237
238 /**
239  * Returns the argument register requirements of an ia32 node.
240  */
241 const arch_register_req_t **get_ia32_in_req_all(const ir_node *node);
242
243 /**
244  * Sets the argument register requirements of an ia32 node.
245  */
246 void set_ia32_in_req_all(ir_node *node, const arch_register_req_t **reqs);
247
248 /**
249  * Returns the result register requirements of an ia32 node.
250  */
251 const arch_register_req_t **get_ia32_out_req_all(const ir_node *node);
252
253 /**
254  * Sets the result register requirements of an ia32 node.
255  */
256 void set_ia32_out_req_all(ir_node *node, const arch_register_req_t **reqs);
257
258 /**
259  * Returns the argument register requirements of an ia32 node.
260  */
261 const arch_register_req_t *get_ia32_in_req(const ir_node *node, int pos);
262
263 /**
264  * Returns the result register requirements of an ia32 node.
265  */
266 const arch_register_req_t *get_ia32_out_req(const ir_node *node, int pos);
267
268 /**
269  * Sets the OUT register requirements at position pos.
270  */
271 void set_ia32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
272
273 /**
274  * Sets the IN register requirements at position pos.
275  */
276 void set_ia32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
277
278 /**
279  * Returns the register flag of an ia32 node.
280  */
281 arch_irn_flags_t get_ia32_flags(const ir_node *node);
282
283 /**
284  * Sets the register flag of an ia32 node.
285  */
286 void set_ia32_flags(ir_node *node, arch_irn_flags_t flags);
287
288 void add_ia32_flags(ir_node *node, arch_irn_flags_t flags);
289
290 /**
291  * Returns the result register slots of an ia32 node.
292  */
293 const arch_register_t **get_ia32_slots(const ir_node *node);
294
295 /**
296  * Returns the name of the OUT register at position pos.
297  */
298 const char *get_ia32_out_reg_name(const ir_node *node, int pos);
299
300 /**
301  * Returns the index of the OUT register at position pos within its register class.
302  */
303 int get_ia32_out_regnr(const ir_node *node, int pos);
304
305 /**
306  * Returns the OUT register at position pos.
307  */
308 const arch_register_t *get_ia32_out_reg(const ir_node *node, int pos);
309
310 /**
311  * Returns the number of results.
312  */
313 int get_ia32_n_res(const ir_node *node);
314
315 /**
316  * Returns the condition code of a node.
317  */
318 long get_ia32_condcode(const ir_node *node);
319
320 /**
321  * Sets the condition code of a node
322  */
323 void set_ia32_condcode(ir_node *node, long code);
324
325 /**
326  * Returns the condition code of a node.
327  */
328 unsigned get_ia32_copyb_size(const ir_node *node);
329
330 /**
331  * Gets the instruction latency.
332  */
333 unsigned get_ia32_latency(const ir_node *node);
334
335
336 /**
337  * Sets the flags for the n'th out.
338  */
339 void set_ia32_out_flags(ir_node *node, arch_irn_flags_t flags, int pos);
340
341 /**
342  * Gets the flags for the n'th out.
343  */
344 arch_irn_flags_t get_ia32_out_flags(const ir_node *node, int pos);
345
346 /**
347  * Get the list of available execution units.
348  */
349 const be_execution_unit_t ***get_ia32_exec_units(const ir_node *node);
350
351 /**
352  * Get the exception label attribute.
353  */
354 unsigned get_ia32_exc_label(const ir_node *node);
355
356 /**
357  * Set the exception label attribute.
358  */
359 void set_ia32_exc_label(ir_node *node, unsigned flag);
360
361 /**
362  * Return the exception label id.
363  */
364 ir_label_t get_ia32_exc_label_id(const ir_node *node);
365
366 /**
367  * Assign the exception label id.
368  */
369 void set_ia32_exc_label_id(ir_node *node, ir_label_t id);
370
371 #ifndef NDEBUG
372
373 /**
374  * Returns the name of the original ir node.
375  */
376 const char *get_ia32_orig_node(const ir_node *node);
377
378 /**
379  * Sets the name of the original ir node.
380  */
381 void set_ia32_orig_node(ir_node *node, const char *name);
382
383 #endif /* NDEBUG */
384
385 /******************************************************************************************************
386  *                      _       _         _   _           __                  _   _
387  *                     (_)     | |       | | | |         / _|                | | (_)
388  *  ___ _ __   ___  ___ _  __ _| |   __ _| |_| |_ _ __  | |_ _   _ _ __   ___| |_ _  ___  _ __    ___
389  * / __| '_ \ / _ \/ __| |/ _` | |  / _` | __| __| '__| |  _| | | | '_ \ / __| __| |/ _ \| '_ \  / __|
390  * \__ \ |_) |  __/ (__| | (_| | | | (_| | |_| |_| |    | | | |_| | | | | (__| |_| | (_) | | | | \__ \
391  * |___/ .__/ \___|\___|_|\__,_|_|  \__,_|\__|\__|_|    |_|  \__,_|_| |_|\___|\__|_|\___/|_| |_| |___/
392  *     | |
393  *     |_|
394  ******************************************************************************************************/
395
396 /**
397  * Returns the ident of an entity
398  * @param ent The entity
399  * @return The ident of the entity
400  */
401 ident *ia32_get_ent_ident(ir_entity *ent);
402
403 /**
404  * Returns the proj of the result value for nodes that have the usual
405  * (res, Mem) result tuple
406  */
407 ir_node *get_ia32_result_proj(const ir_node *node);
408
409 /**
410  * Copy the attributes from a Const to an ia32_Const
411  */
412 void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
413
414 void set_ia32_Const_tarval(ir_node *node, tarval *tv);
415
416 /**
417  * Returns whether or not the node is an AddrModeS node.
418  */
419 int is_ia32_AddrModeS(const ir_node *node);
420
421 /**
422  * Returns whether or not the node is an AddrModeD node.
423  */
424 int is_ia32_AddrModeD(const ir_node *node);
425
426 /**
427  * Checks if node is a Load or fLoad.
428  */
429 int is_ia32_Ld(const ir_node *node);
430
431 /**
432  * Checks if node is a Store or fStore.
433  */
434 int is_ia32_St(const ir_node *node);
435
436 /**
437  * Swaps left/right input of a node (and adjusts pnc if needed)
438  */
439 void ia32_swap_left_right(ir_node *node);
440
441 /**
442  * Initializes the nodes attributes.
443  */
444 void init_ia32_attributes(ir_node *node, arch_irn_flags_t flags,
445                           const arch_register_req_t **in_reqs,
446                           const arch_register_req_t **out_reqs,
447                           const be_execution_unit_t ***execution_units,
448                           int n_res);
449
450 void init_ia32_x87_attributes(ir_node *node);
451 void init_ia32_asm_attributes(ir_node *node);
452 void init_ia32_immediate_attributes(ir_node *node, ir_entity *symconst,
453                                     int symconst_sign, long offset);
454 void init_ia32_copyb_attributes(ir_node *res, unsigned size);
455 void init_ia32_condcode_attributes(ir_node *res, long pnc);
456
457 /* Include the generated headers */
458 #include "gen_ia32_new_nodes.h"
459
460 #endif /* FIRM_BE_IA32_IA32_NEW_NODES_H */