Remove the unused function be_liveness_nodes_live_at_input().
[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 Call node attributes.
91  */
92 ia32_call_attr_t *get_ia32_call_attr(ir_node *node);
93 const ia32_call_attr_t *get_ia32_call_attr_const(const ir_node *node);
94
95 /**
96  * Gets the CopyB node attributes.
97  */
98 ia32_copyb_attr_t *get_ia32_copyb_attr(ir_node *node);
99 const ia32_copyb_attr_t *get_ia32_copyb_attr_const(const ir_node *node);
100
101 /**
102  * Gets the type of an ia32 node.
103  */
104 ia32_op_type_t get_ia32_op_type(const ir_node *node);
105
106 /**
107  * Sets the type of an ia32 node.
108  */
109 void set_ia32_op_type(ir_node *node, ia32_op_type_t tp);
110
111 /**
112  * Gets the supported address mode of an ia32 node
113  */
114 ia32_am_type_t get_ia32_am_support(const ir_node *node);
115
116 /**
117  * Sets the supported addrmode of an ia32 node
118  */
119 void set_ia32_am_support(ir_node *node, ia32_am_type_t am_arity);
120
121 /**
122  * Gets the addressmode offset as long.
123  */
124 int get_ia32_am_offs_int(const ir_node *node);
125
126 /**
127  * Sets the addressmode offset
128  */
129 void set_ia32_am_offs_int(ir_node *node, int offset);
130
131 void add_ia32_am_offs_int(ir_node *node, int offset);
132
133 /**
134  * Returns the symconst entity associated to addrmode.
135  */
136 ir_entity *get_ia32_am_sc(const ir_node *node);
137
138 /**
139  * Sets the symconst entity associated to addrmode.
140  */
141 void set_ia32_am_sc(ir_node *node, ir_entity *sc);
142
143 /**
144  * Sets the sign bit for address mode symconst.
145  */
146 void set_ia32_am_sc_sign(ir_node *node);
147
148 /**
149  * Clears the sign bit for address mode symconst.
150  */
151 void clear_ia32_am_sc_sign(ir_node *node);
152
153 /**
154  * Returns the sign bit for address mode symconst.
155  */
156 int is_ia32_am_sc_sign(const ir_node *node);
157
158 /**
159  * Gets the addr mode const.
160  */
161 int get_ia32_am_scale(const ir_node *node);
162
163 /**
164  * Sets the const for addr mode.
165  */
166 void set_ia32_am_scale(ir_node *node, int scale);
167
168 /**
169  * Sets the uses_frame flag.
170  */
171 void set_ia32_use_frame(ir_node *node);
172
173 /**
174  * Clears the uses_frame flag.
175  */
176 void clear_ia32_use_frame(ir_node *node);
177
178 /**
179  * Gets the uses_frame flag.
180  */
181 int is_ia32_use_frame(const ir_node *node);
182
183 /**
184  * copies all address-mode attributes from one node to the other
185  */
186 void ia32_copy_am_attrs(ir_node *to, const ir_node *from);
187
188 /**
189  * Sets node to commutative.
190  */
191 void set_ia32_commutative(ir_node *node);
192
193 /**
194  * Sets node to non-commutative.
195  */
196 void clear_ia32_commutative(ir_node *node);
197
198 /**
199  * Checks if node is commutative.
200  */
201 int is_ia32_commutative(const ir_node *node);
202
203 /**
204  * Sets node needs_stackent
205  */
206 void set_ia32_need_stackent(ir_node *node);
207
208 /**
209  * Clears node needs_stackent
210  */
211 void clear_ia32_need_stackent(ir_node *node);
212
213 /**
214  * Checks if node needs a stack entity assigned
215  */
216 int is_ia32_need_stackent(const ir_node *node);
217
218 void set_ia32_is_reload(ir_node *node);
219 int is_ia32_is_reload(const ir_node *node);
220
221 void set_ia32_is_spill(ir_node *node);
222 int is_ia32_is_spill(const ir_node *node);
223
224 void set_ia32_is_remat(ir_node *node);
225 int is_ia32_is_remat(const ir_node *node);
226
227 /**
228  * Gets the mode of the stored/loaded value (only set for Store/Load)
229  */
230 ir_mode *get_ia32_ls_mode(const ir_node *node);
231
232 /**
233  * Sets the mode of the stored/loaded value (only set for Store/Load)
234  */
235 void set_ia32_ls_mode(ir_node *node, ir_mode *mode);
236
237 /**
238  * Gets the frame entity assigned to this node;
239  */
240 ir_entity *get_ia32_frame_ent(const ir_node *node);
241
242 /**
243  * Sets the frame entity for this node;
244  */
245 void set_ia32_frame_ent(ir_node *node, ir_entity *ent);
246
247 /**
248  * Returns the argument register requirements of an ia32 node.
249  */
250 const arch_register_req_t **get_ia32_in_req_all(const ir_node *node);
251
252 /**
253  * Sets the argument register requirements of an ia32 node.
254  */
255 void set_ia32_in_req_all(ir_node *node, const arch_register_req_t **reqs);
256
257 /**
258  * Returns the result register requirements of an ia32 node.
259  */
260 const arch_register_req_t **get_ia32_out_req_all(const ir_node *node);
261
262 /**
263  * Sets the result register requirements of an ia32 node.
264  */
265 void set_ia32_out_req_all(ir_node *node, const arch_register_req_t **reqs);
266
267 /**
268  * Returns the argument register requirements of an ia32 node.
269  */
270 const arch_register_req_t *get_ia32_in_req(const ir_node *node, int pos);
271
272 /**
273  * Returns the result register requirements of an ia32 node.
274  */
275 const arch_register_req_t *get_ia32_out_req(const ir_node *node, int pos);
276
277 /**
278  * Sets the OUT register requirements at position pos.
279  */
280 void set_ia32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
281
282 /**
283  * Sets the IN register requirements at position pos.
284  */
285 void set_ia32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
286
287 /**
288  * Returns the register flag of an ia32 node.
289  */
290 arch_irn_flags_t get_ia32_flags(const ir_node *node);
291
292 /**
293  * Sets the register flag of an ia32 node.
294  */
295 void set_ia32_flags(ir_node *node, arch_irn_flags_t flags);
296
297 void add_ia32_flags(ir_node *node, arch_irn_flags_t flags);
298
299 /**
300  * Returns the result register slots of an ia32 node.
301  */
302 const arch_register_t **get_ia32_slots(const ir_node *node);
303
304 /**
305  * Returns the name of the OUT register at position pos.
306  */
307 const char *get_ia32_out_reg_name(const ir_node *node, int pos);
308
309 /**
310  * Returns the index of the OUT register at position pos within its register class.
311  */
312 int get_ia32_out_regnr(const ir_node *node, int pos);
313
314 /**
315  * Returns the OUT register at position pos.
316  */
317 const arch_register_t *get_ia32_out_reg(const ir_node *node, int pos);
318
319 /**
320  * Returns the number of results.
321  */
322 int get_ia32_n_res(const ir_node *node);
323
324 /**
325  * Returns the condition code of a node.
326  */
327 long get_ia32_condcode(const ir_node *node);
328
329 /**
330  * Sets the condition code of a node
331  */
332 void set_ia32_condcode(ir_node *node, long code);
333
334 /**
335  * Returns the condition code of a node.
336  */
337 unsigned get_ia32_copyb_size(const ir_node *node);
338
339 /**
340  * Gets the instruction latency.
341  */
342 unsigned get_ia32_latency(const ir_node *node);
343
344
345 /**
346  * Sets the flags for the n'th out.
347  */
348 void set_ia32_out_flags(ir_node *node, arch_irn_flags_t flags, int pos);
349
350 /**
351  * Gets the flags for the n'th out.
352  */
353 arch_irn_flags_t get_ia32_out_flags(const ir_node *node, int pos);
354
355 /**
356  * Get the list of available execution units.
357  */
358 const be_execution_unit_t ***get_ia32_exec_units(const ir_node *node);
359
360 /**
361  * Get the exception label attribute.
362  */
363 unsigned get_ia32_exc_label(const ir_node *node);
364
365 /**
366  * Set the exception label attribute.
367  */
368 void set_ia32_exc_label(ir_node *node, unsigned flag);
369
370 /**
371  * Return the exception label id.
372  */
373 ir_label_t get_ia32_exc_label_id(const ir_node *node);
374
375 /**
376  * Assign the exception label id.
377  */
378 void set_ia32_exc_label_id(ir_node *node, ir_label_t id);
379
380 #ifndef NDEBUG
381
382 /**
383  * Returns the name of the original ir node.
384  */
385 const char *get_ia32_orig_node(const ir_node *node);
386
387 /**
388  * Sets the name of the original ir node.
389  */
390 void set_ia32_orig_node(ir_node *node, const char *name);
391
392 #endif /* NDEBUG */
393
394 /******************************************************************************************************
395  *                      _       _         _   _           __                  _   _
396  *                     (_)     | |       | | | |         / _|                | | (_)
397  *  ___ _ __   ___  ___ _  __ _| |   __ _| |_| |_ _ __  | |_ _   _ _ __   ___| |_ _  ___  _ __    ___
398  * / __| '_ \ / _ \/ __| |/ _` | |  / _` | __| __| '__| |  _| | | | '_ \ / __| __| |/ _ \| '_ \  / __|
399  * \__ \ |_) |  __/ (__| | (_| | | | (_| | |_| |_| |    | | | |_| | | | | (__| |_| | (_) | | | | \__ \
400  * |___/ .__/ \___|\___|_|\__,_|_|  \__,_|\__|\__|_|    |_|  \__,_|_| |_|\___|\__|_|\___/|_| |_| |___/
401  *     | |
402  *     |_|
403  ******************************************************************************************************/
404
405 /**
406  * Returns the ident of an entity
407  * @param ent The entity
408  * @return The ident of the entity
409  */
410 ident *ia32_get_ent_ident(ir_entity *ent);
411
412 /**
413  * Returns the proj of the result value for nodes that have the usual
414  * (res, Mem) result tuple
415  */
416 ir_node *get_ia32_result_proj(const ir_node *node);
417
418 /**
419  * Copy the attributes from a Const to an ia32_Const
420  */
421 void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
422
423 void set_ia32_Const_tarval(ir_node *node, tarval *tv);
424
425 /**
426  * Returns whether or not the node is an AddrModeS node.
427  */
428 int is_ia32_AddrModeS(const ir_node *node);
429
430 /**
431  * Returns whether or not the node is an AddrModeD node.
432  */
433 int is_ia32_AddrModeD(const ir_node *node);
434
435 /**
436  * Checks if node is a Load or fLoad.
437  */
438 int is_ia32_Ld(const ir_node *node);
439
440 /**
441  * Checks if node is a Store or fStore.
442  */
443 int is_ia32_St(const ir_node *node);
444
445 /**
446  * Swaps left/right input of a node (and adjusts pnc if needed)
447  */
448 void ia32_swap_left_right(ir_node *node);
449
450 /**
451  * Initializes the nodes attributes.
452  */
453 void init_ia32_attributes(ir_node *node, arch_irn_flags_t flags,
454                           const arch_register_req_t **in_reqs,
455                           const arch_register_req_t **out_reqs,
456                           const be_execution_unit_t ***execution_units,
457                           int n_res);
458
459 void init_ia32_x87_attributes(ir_node *node);
460 void init_ia32_asm_attributes(ir_node *node);
461 void init_ia32_immediate_attributes(ir_node *node, ir_entity *symconst,
462                                     int symconst_sign, long offset);
463 void init_ia32_call_attributes(ir_node *res, unsigned pop, ir_type *call_tp);
464 void init_ia32_copyb_attributes(ir_node *res, unsigned size);
465 void init_ia32_condcode_attributes(ir_node *res, long pnc);
466
467 /* Include the generated headers */
468 #include "gen_ia32_new_nodes.h"
469
470 #endif /* FIRM_BE_IA32_IA32_NEW_NODES_H */