set_ia32_op_type() want ia32_AddrModeS, not ia32_am_Source (though they happen to...
[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 void set_ia32_is_spill(ir_node *node);
219 int is_ia32_is_spill(const ir_node *node);
220
221 void set_ia32_is_remat(ir_node *node);
222 int is_ia32_is_remat(const ir_node *node);
223
224 /**
225  * Gets the mode of the stored/loaded value (only set for Store/Load)
226  */
227 ir_mode *get_ia32_ls_mode(const ir_node *node);
228
229 /**
230  * Sets the mode of the stored/loaded value (only set for Store/Load)
231  */
232 void set_ia32_ls_mode(ir_node *node, ir_mode *mode);
233
234 /**
235  * Gets the frame entity assigned to this node;
236  */
237 ir_entity *get_ia32_frame_ent(const ir_node *node);
238
239 /**
240  * Sets the frame entity for this node;
241  */
242 void set_ia32_frame_ent(ir_node *node, ir_entity *ent);
243
244 /**
245  * Returns the argument register requirements of an ia32 node.
246  */
247 const arch_register_req_t **get_ia32_in_req_all(const ir_node *node);
248
249 /**
250  * Sets the argument register requirements of an ia32 node.
251  */
252 void set_ia32_in_req_all(ir_node *node, const arch_register_req_t **reqs);
253
254 /**
255  * Returns the result register requirements of an ia32 node.
256  */
257 const arch_register_req_t **get_ia32_out_req_all(const ir_node *node);
258
259 /**
260  * Sets the result register requirements of an ia32 node.
261  */
262 void set_ia32_out_req_all(ir_node *node, const arch_register_req_t **reqs);
263
264 /**
265  * Returns the argument register requirements of an ia32 node.
266  */
267 const arch_register_req_t *get_ia32_in_req(const ir_node *node, int pos);
268
269 /**
270  * Returns the result register requirements of an ia32 node.
271  */
272 const arch_register_req_t *get_ia32_out_req(const ir_node *node, int pos);
273
274 /**
275  * Sets the OUT register requirements at position pos.
276  */
277 void set_ia32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
278
279 /**
280  * Sets the IN register requirements at position pos.
281  */
282 void set_ia32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
283
284 /**
285  * Returns the register flag of an ia32 node.
286  */
287 arch_irn_flags_t get_ia32_flags(const ir_node *node);
288
289 /**
290  * Sets the register flag of an ia32 node.
291  */
292 void set_ia32_flags(ir_node *node, arch_irn_flags_t flags);
293
294 void add_ia32_flags(ir_node *node, arch_irn_flags_t flags);
295
296 /**
297  * Returns the result register slots of an ia32 node.
298  */
299 const arch_register_t **get_ia32_slots(const ir_node *node);
300
301 /**
302  * Returns the name of the OUT register at position pos.
303  */
304 const char *get_ia32_out_reg_name(const ir_node *node, int pos);
305
306 /**
307  * Returns the index of the OUT register at position pos within its register class.
308  */
309 int get_ia32_out_regnr(const ir_node *node, int pos);
310
311 /**
312  * Returns the OUT register at position pos.
313  */
314 const arch_register_t *get_ia32_out_reg(const ir_node *node, int pos);
315
316 /**
317  * Returns the number of results.
318  */
319 int get_ia32_n_res(const ir_node *node);
320
321 /**
322  * Returns the condition code of a node.
323  */
324 long get_ia32_condcode(const ir_node *node);
325
326 /**
327  * Sets the condition code of a node
328  */
329 void set_ia32_condcode(ir_node *node, long code);
330
331 /**
332  * Returns the condition code of a node.
333  */
334 unsigned get_ia32_copyb_size(const ir_node *node);
335
336 /**
337  * Gets the instruction latency.
338  */
339 unsigned get_ia32_latency(const ir_node *node);
340
341
342 /**
343  * Sets the flags for the n'th out.
344  */
345 void set_ia32_out_flags(ir_node *node, arch_irn_flags_t flags, int pos);
346
347 /**
348  * Gets the flags for the n'th out.
349  */
350 arch_irn_flags_t get_ia32_out_flags(const ir_node *node, int pos);
351
352 /**
353  * Get the list of available execution units.
354  */
355 const be_execution_unit_t ***get_ia32_exec_units(const ir_node *node);
356
357 /**
358  * Get the exception label attribute.
359  */
360 unsigned get_ia32_exc_label(const ir_node *node);
361
362 /**
363  * Set the exception label attribute.
364  */
365 void set_ia32_exc_label(ir_node *node, unsigned flag);
366
367 /**
368  * Return the exception label id.
369  */
370 ir_label_t get_ia32_exc_label_id(const ir_node *node);
371
372 /**
373  * Assign the exception label id.
374  */
375 void set_ia32_exc_label_id(ir_node *node, ir_label_t id);
376
377 #ifndef NDEBUG
378
379 /**
380  * Returns the name of the original ir node.
381  */
382 const char *get_ia32_orig_node(const ir_node *node);
383
384 /**
385  * Sets the name of the original ir node.
386  */
387 void set_ia32_orig_node(ir_node *node, const char *name);
388
389 #endif /* NDEBUG */
390
391 /******************************************************************************************************
392  *                      _       _         _   _           __                  _   _
393  *                     (_)     | |       | | | |         / _|                | | (_)
394  *  ___ _ __   ___  ___ _  __ _| |   __ _| |_| |_ _ __  | |_ _   _ _ __   ___| |_ _  ___  _ __    ___
395  * / __| '_ \ / _ \/ __| |/ _` | |  / _` | __| __| '__| |  _| | | | '_ \ / __| __| |/ _ \| '_ \  / __|
396  * \__ \ |_) |  __/ (__| | (_| | | | (_| | |_| |_| |    | | | |_| | | | | (__| |_| | (_) | | | | \__ \
397  * |___/ .__/ \___|\___|_|\__,_|_|  \__,_|\__|\__|_|    |_|  \__,_|_| |_|\___|\__|_|\___/|_| |_| |___/
398  *     | |
399  *     |_|
400  ******************************************************************************************************/
401
402 /**
403  * Returns the ident of an entity
404  * @param ent The entity
405  * @return The ident of the entity
406  */
407 ident *ia32_get_ent_ident(ir_entity *ent);
408
409 /**
410  * Returns the proj of the result value for nodes that have the usual
411  * (res, Mem) result tuple
412  */
413 ir_node *get_ia32_result_proj(const ir_node *node);
414
415 /**
416  * Copy the attributes from a Const to an ia32_Const
417  */
418 void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
419
420 void set_ia32_Const_tarval(ir_node *node, tarval *tv);
421
422 /**
423  * Returns whether or not the node is an AddrModeS node.
424  */
425 int is_ia32_AddrModeS(const ir_node *node);
426
427 /**
428  * Returns whether or not the node is an AddrModeD node.
429  */
430 int is_ia32_AddrModeD(const ir_node *node);
431
432 /**
433  * Checks if node is a Load or fLoad.
434  */
435 int is_ia32_Ld(const ir_node *node);
436
437 /**
438  * Checks if node is a Store or fStore.
439  */
440 int is_ia32_St(const ir_node *node);
441
442 /**
443  * Swaps left/right input of a node (and adjusts pnc if needed)
444  */
445 void ia32_swap_left_right(ir_node *node);
446
447 /**
448  * Initializes the nodes attributes.
449  */
450 void init_ia32_attributes(ir_node *node, arch_irn_flags_t flags,
451                           const arch_register_req_t **in_reqs,
452                           const arch_register_req_t **out_reqs,
453                           const be_execution_unit_t ***execution_units,
454                           int n_res);
455
456 void init_ia32_x87_attributes(ir_node *node);
457 void init_ia32_asm_attributes(ir_node *node);
458 void init_ia32_immediate_attributes(ir_node *node, ir_entity *symconst,
459                                     int symconst_sign, long offset);
460 void init_ia32_copyb_attributes(ir_node *res, unsigned size);
461 void init_ia32_condcode_attributes(ir_node *res, long pnc);
462
463 /* Include the generated headers */
464 #include "gen_ia32_new_nodes.h"
465
466 #endif /* FIRM_BE_IA32_IA32_NEW_NODES_H */