7624e6a0448494a200460af48d68ce78fc6067db
[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 /** 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_mem   = 1,
50         pn_ia32_flags = 2
51 };
52
53 /***************************************************************************************************
54  *        _   _                   _       __        _                    _   _               _
55  *       | | | |                 | |     / /       | |                  | | | |             | |
56  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
57  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
58  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
59  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
60  *                                        __/ |
61  *                                       |___/
62  ***************************************************************************************************/
63
64 /**
65  * returns true if a node has x87 registers
66  */
67 int ia32_has_x87_register(const ir_node *n);
68
69 /**
70  * Returns the attributes of an ia32 node.
71  */
72 ia32_attr_t *get_ia32_attr(ir_node *node);
73 const ia32_attr_t *get_ia32_attr_const(const ir_node *node);
74
75 ia32_x87_attr_t *get_ia32_x87_attr(ir_node *node);
76 const ia32_x87_attr_t *get_ia32_x87_attr_const(const ir_node *node);
77
78 const ia32_immediate_attr_t *get_ia32_immediate_attr_const(const ir_node *node);
79
80 /**
81  * Gets the condcode attributes of a node.
82  */
83 ia32_condcode_attr_t *get_ia32_condcode_attr(ir_node *node);
84 const ia32_condcode_attr_t *get_ia32_condcode_attr_const(const ir_node *node);
85
86 /**
87  * Gets the CopyB node attributes.
88  */
89 ia32_copyb_attr_t *get_ia32_copyb_attr(ir_node *node);
90 const ia32_copyb_attr_t *get_ia32_copyb_attr_const(const ir_node *node);
91
92 /**
93  * Gets the type of an ia32 node.
94  */
95 ia32_op_type_t get_ia32_op_type(const ir_node *node);
96
97 /**
98  * Sets the type of an ia32 node.
99  */
100 void set_ia32_op_type(ir_node *node, ia32_op_type_t tp);
101
102 /**
103  * Gets the supported addrmode of an ia32 node
104  */
105 ia32_am_type_t get_ia32_am_support(const ir_node *node);
106
107 ia32_am_arity_t get_ia32_am_arity(const ir_node *node);
108
109 /**
110  * Sets the supported addrmode of an ia32 node
111  */
112 void set_ia32_am_support(ir_node *node, ia32_am_type_t am_tp,
113                          ia32_am_arity_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 /**
213  * Gets the mode of the stored/loaded value (only set for Store/Load)
214  */
215 ir_mode *get_ia32_ls_mode(const ir_node *node);
216
217 /**
218  * Sets the mode of the stored/loaded value (only set for Store/Load)
219  */
220 void set_ia32_ls_mode(ir_node *node, ir_mode *mode);
221
222 /**
223  * Gets the frame entity assigned to this node;
224  */
225 ir_entity *get_ia32_frame_ent(const ir_node *node);
226
227 /**
228  * Sets the frame entity for this node;
229  */
230 void set_ia32_frame_ent(ir_node *node, ir_entity *ent);
231
232 /**
233  * Returns the argument register requirements of an ia32 node.
234  */
235 const arch_register_req_t **get_ia32_in_req_all(const ir_node *node);
236
237 /**
238  * Sets the argument register requirements of an ia32 node.
239  */
240 void set_ia32_in_req_all(ir_node *node, const arch_register_req_t **reqs);
241
242 /**
243  * Returns the result register requirements of an ia32 node.
244  */
245 const arch_register_req_t **get_ia32_out_req_all(const ir_node *node);
246
247 /**
248  * Sets the result register requirements of an ia32 node.
249  */
250 void set_ia32_out_req_all(ir_node *node, const arch_register_req_t **reqs);
251
252 /**
253  * Returns the argument register requirements of an ia32 node.
254  */
255 const arch_register_req_t *get_ia32_in_req(const ir_node *node, int pos);
256
257 /**
258  * Returns the result register requirements of an ia32 node.
259  */
260 const arch_register_req_t *get_ia32_out_req(const ir_node *node, int pos);
261
262 /**
263  * Sets the OUT register requirements at position pos.
264  */
265 void set_ia32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
266
267 /**
268  * Sets the IN register requirements at position pos.
269  */
270 void set_ia32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
271
272 /**
273  * Returns the register flag of an ia32 node.
274  */
275 arch_irn_flags_t get_ia32_flags(const ir_node *node);
276
277 /**
278  * Sets the register flag of an ia32 node.
279  */
280 void set_ia32_flags(ir_node *node, arch_irn_flags_t flags);
281
282 /**
283  * Returns the result register slots of an ia32 node.
284  */
285 const arch_register_t **get_ia32_slots(const ir_node *node);
286
287 /**
288  * Returns the name of the OUT register at position pos.
289  */
290 const char *get_ia32_out_reg_name(const ir_node *node, int pos);
291
292 /**
293  * Returns the index of the OUT register at position pos within its register class.
294  */
295 int get_ia32_out_regnr(const ir_node *node, int pos);
296
297 /**
298  * Returns the OUT register at position pos.
299  */
300 const arch_register_t *get_ia32_out_reg(const ir_node *node, int pos);
301
302 /**
303  * Returns the number of results.
304  */
305 int get_ia32_n_res(const ir_node *node);
306
307 /**
308  * Returns the condition code of a node.
309  */
310 long get_ia32_condcode(const ir_node *node);
311
312 /**
313  * Sets the condition code of a node
314  */
315 void set_ia32_condcode(ir_node *node, long code);
316
317 /**
318  * Returns the condition code of a node.
319  */
320 unsigned get_ia32_copyb_size(const ir_node *node);
321
322 /**
323  * Gets the instruction latency.
324  */
325 unsigned get_ia32_latency(const ir_node *node);
326
327 /**
328  * Sets the instruction latency.
329  */
330 void set_ia32_latency(ir_node *node, unsigned latency);
331
332
333 /**
334  * Sets the flags for the n'th out.
335  */
336 void set_ia32_out_flags(ir_node *node, arch_irn_flags_t flags, int pos);
337
338 /**
339  * Gets the flags for the n'th out.
340  */
341 arch_irn_flags_t get_ia32_out_flags(const ir_node *node, int pos);
342
343 /**
344  * Get the list of available execution units.
345  */
346 const be_execution_unit_t ***get_ia32_exec_units(const ir_node *node);
347
348 /**
349  * Get the exception label attribute.
350  */
351 unsigned get_ia32_exc_label(const ir_node *node);
352
353 /**
354  * Set the exception label attribute.
355  */
356 void set_ia32_exc_label(ir_node *node, unsigned flag);
357
358 #ifndef NDEBUG
359
360 /**
361  * Returns the name of the original ir node.
362  */
363 const char *get_ia32_orig_node(const ir_node *node);
364
365 /**
366  * Sets the name of the original ir node.
367  */
368 void set_ia32_orig_node(ir_node *node, const char *name);
369
370 #endif /* NDEBUG */
371
372 /******************************************************************************************************
373  *                      _       _         _   _           __                  _   _
374  *                     (_)     | |       | | | |         / _|                | | (_)
375  *  ___ _ __   ___  ___ _  __ _| |   __ _| |_| |_ _ __  | |_ _   _ _ __   ___| |_ _  ___  _ __    ___
376  * / __| '_ \ / _ \/ __| |/ _` | |  / _` | __| __| '__| |  _| | | | '_ \ / __| __| |/ _ \| '_ \  / __|
377  * \__ \ |_) |  __/ (__| | (_| | | | (_| | |_| |_| |    | | | |_| | | | | (__| |_| | (_) | | | | \__ \
378  * |___/ .__/ \___|\___|_|\__,_|_|  \__,_|\__|\__|_|    |_|  \__,_|_| |_|\___|\__|_|\___/|_| |_| |___/
379  *     | |
380  *     |_|
381  ******************************************************************************************************/
382
383 /**
384  * Returns the ident of an entity
385  * @param ent The entity
386  * @return The ident of the entity
387  */
388 ident *ia32_get_ent_ident(ir_entity *ent);
389
390 /**
391  * Returns the proj of the result value for nodes that have the usual
392  * (res, Mem) result tuple
393  */
394 ir_node *get_ia32_result_proj(const ir_node *node);
395
396 /**
397  * Copy the attributes from a Const to an ia32_Const
398  */
399 void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
400
401 void set_ia32_Const_tarval(ir_node *node, tarval *tv);
402
403 /**
404  * Returns whether or not the node is an AddrModeS node.
405  */
406 int is_ia32_AddrModeS(const ir_node *node);
407
408 /**
409  * Returns whether or not the node is an AddrModeD node.
410  */
411 int is_ia32_AddrModeD(const ir_node *node);
412
413 /**
414  * Checks if node is a Load or fLoad.
415  */
416 int is_ia32_Ld(const ir_node *node);
417
418 /**
419  * Checks if node is a Store or fStore.
420  */
421 int is_ia32_St(const ir_node *node);
422
423 /**
424  * Swaps left/right input of a node (and adjusts pnc if needed)
425  */
426 void ia32_swap_left_right(ir_node *node);
427
428 /**
429  * Initializes the nodes attributes.
430  */
431 void init_ia32_attributes(ir_node *node, arch_irn_flags_t flags,
432                           const arch_register_req_t **in_reqs,
433                           const arch_register_req_t **out_reqs,
434                           const be_execution_unit_t ***execution_units,
435                           int n_res, unsigned latency);
436
437 void init_ia32_x87_attributes(ir_node *node);
438 void init_ia32_asm_attributes(ir_node *node);
439 void init_ia32_immediate_attributes(ir_node *node, ir_entity *symconst,
440                                     int symconst_sign, long offset);
441 void init_ia32_copyb_attributes(ir_node *res, unsigned size);
442 void init_ia32_condcode_attributes(ir_node *res, long pnc);
443
444 /* Include the generated headers */
445 #include "gen_ia32_new_nodes.h"
446
447 #endif /* FIRM_BE_IA32_IA32_NEW_NODES_H */