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