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