2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Representation of an intermediate operation -- private header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
25 #ifndef FIRM_IR_IRNODE_T_H
26 #define FIRM_IR_IRNODE_T_H
31 #include "irgraph_t.h"
34 #include "iredges_t.h"
36 /* This section MUST come first, so the inline functions get used in this header. */
37 #define is_ir_node(thing) is_ir_node_(thing)
38 #define get_irn_arity(node) get_irn_arity_(node)
39 #define get_irn_n(node, n) get_irn_n_(node, n)
40 #define get_irn_mode(node) get_irn_mode_(node)
41 #define set_irn_mode(node, mode) set_irn_mode_(node, mode)
42 #define get_irn_irg(node) get_irn_irg_(node)
43 #define get_nodes_block(node) get_nodes_block_(node)
44 #define get_irn_op(node) get_irn_op_(node)
45 #define set_irn_op(node, op) set_irn_op_(node, op)
46 #define get_irn_opcode(node) get_irn_opcode_(node)
47 #define get_irn_visited(node) get_irn_visited_(node)
48 #define set_irn_visited(node, v) set_irn_visited_(node, v)
49 #define mark_irn_visited(node) mark_irn_visited_(node)
50 #define irn_visited(node) irn_visited_(node)
51 #define irn_visited_else_mark(node) irn_visited_else_mark_(node)
52 #define set_irn_link(node, link) set_irn_link_(node, link)
53 #define get_irn_link(node) get_irn_link_(node)
54 #define get_irn_pinned(node) get_irn_pinned_(node)
55 #define is_irn_pinned_in_irg(node) is_irn_pinned_in_irg_(node)
56 #define is_unop(node) is_unop_(node)
57 #define is_binop(node) is_binop_(node)
58 #define is_SymConst_addr_ent(node) is_SymConst_addr_ent_(node)
59 #define get_Block_n_cfgpreds(node) get_Block_n_cfgpreds_(node)
60 #define get_Block_cfgpred(node, pos) get_Block_cfgpred_(node, pos)
61 #define get_Block_cfgpred_block(node, pos) get_Block_cfgpred_block_(node, pos)
62 #define get_Block_block_visited(node) get_Block_block_visited_(node)
63 #define set_Block_block_visited(node, visit) set_Block_block_visited_(node, visit)
64 #define mark_Block_block_visited(node) mark_Block_block_visited_(node)
65 #define Block_block_visited(node) Block_block_visited_(node)
66 #define get_Block_irg(block) get_Block_irg_(block)
67 #define is_Const_null(node) is_Const_null_(node)
68 #define is_Const_one(node) is_Const_one_(node)
69 #define is_Const_all_one(node) is_Const_all_one_(node)
70 #define is_irn_forking(node) is_irn_forking_(node)
71 #define copy_node_attr(irg,oldn,newn) copy_node_attr_(irg,oldn,newn)
72 #define get_irn_type(node) get_irn_type_(node)
73 #define get_irn_type_attr(node) get_irn_type_attr_(node)
74 #define get_irn_entity_attr(node) get_irn_entity_attr_(node)
75 #define is_irn_constlike(node) is_irn_constlike_(node)
76 #define is_irn_keep(node) is_irn_keep_(node)
77 #define is_irn_start_block_placed(node) is_irn_start_block_placed_(node)
78 #define is_irn_cse_neutral(node) is_irn_cse_neutral_(node)
79 #define get_irn_generic_attr(node) get_irn_generic_attr_(node)
80 #define get_irn_generic_attr_const(node) get_irn_generic_attr_const_(node)
81 #define get_irn_idx(node) get_irn_idx_(node)
83 #define get_irn_deps(node) get_irn_deps_(node)
84 #define get_irn_dep(node, pos) get_irn_dep_(node, pos)
86 #define get_irn_ins_or_deps(node) get_irn_ins_or_deps_(node)
87 #define get_irn_in_or_dep(node, pos) get_irn_in_or_dep_(node, pos)
89 #define get_irn_dbg_info(node) get_irn_dbg_info_(node)
90 #define set_irn_dbg_info(node, db) set_irn_dbg_info_(node, db)
92 #define set_Block_phis(block, phi) set_Block_phis_(block, phi)
93 #define get_Block_phis(block) get_Block_phis_(block)
94 #define add_Block_phi(block, phi) add_Block_phi_(block, phi)
95 #define get_Block_mark(block) get_Block_mark_(block)
96 #define set_Block_mark(block, mark) set_Block_mark_(block, mark)
98 #define set_Phi_next(node, phi) set_Phi_next_(node, phi)
99 #define get_Phi_next(node) get_Phi_next_(node)
101 #define is_arg_Proj(node) is_arg_Proj_(node)
102 #define ir_switch_table_get_n_entries(table) ir_switch_table_get_n_entries_(table)
105 * Returns the array with the ins. The content of the array may not be
107 * Note that this function returns the whole in array including the
108 * block predecessor. So, it is NOT symmetric with set_irn_in().
110 ir_node **get_irn_in(const ir_node *node);
112 /*-------------------------------------------------------------------*/
113 /* These function are most used in libfirm. Give them as static */
114 /* functions so they can be inlined. */
115 /*-------------------------------------------------------------------*/
118 * Checks whether a pointer points to a ir node.
119 * Intern version for libFirm.
121 static inline int is_ir_node_(const void *thing)
123 return (get_kind(thing) == k_ir_node);
126 static inline unsigned get_irn_idx_(const ir_node *node)
128 return node->node_idx;
132 * Gets the op of a node.
133 * Intern version for libFirm.
135 static inline ir_op *get_irn_op_(const ir_node *node)
140 static inline void set_irn_op_(ir_node *node, ir_op *op)
145 /** Copies all attributes stored in the old node to the new node.
146 Assumes both have the same opcode and sufficient size. */
147 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
150 ir_op *op = get_irn_op_(old_node);
152 /* must always exist */
153 op->ops.copy_attr(irg, old_node, new_node);
157 * Gets the opcode of a node.
158 * Intern version for libFirm.
160 static inline unsigned get_irn_opcode_(const ir_node *node)
162 assert(k_ir_node == get_kind(node));
163 return node->op->code;
167 * Returns the number of predecessors without the block predecessor.
168 * Intern version for libFirm.
170 static inline int get_irn_arity_(const ir_node *node)
172 return (int)(ARR_LEN(node->in) - 1);
175 /* forward decl... */
176 #define is_Id(node) is_Id_(node)
177 static inline int is_Id_(const ir_node *node);
180 * Intern version for libFirm.
182 static inline ir_node *get_irn_n_(const ir_node *node, int n)
186 assert(-1 <= n && n < get_irn_arity_(node));
188 nn = node->in[n + 1];
189 if (!is_Id(nn)) return nn;
191 return (node->in[n + 1] = skip_Id(nn));
194 /* include generated code */
195 #include "gen_irnode.h"
198 * returns a hash value for a node
200 static inline unsigned hash_irn(const ir_node *node)
202 return (unsigned) get_irn_idx(node);
205 static inline int get_irn_deps_(const ir_node *node)
207 return node->deps ? (int)ARR_LEN(node->deps) : 0;
210 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
212 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
213 return node->deps[pos];
216 /* forward declaration outside iredges_t.h to avoid circular include problems */
217 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
219 static inline int get_irn_ins_or_deps_(const ir_node *irn)
221 return get_irn_deps_(irn) + get_irn_arity_(irn);
224 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
226 int n_in = get_irn_arity(irn);
227 return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
231 * Gets the mode of a node.
232 * Intern version for libFirm.
234 static inline ir_mode *get_irn_mode_(const ir_node *node)
240 * Sets the mode of a node.
241 * Intern version of libFirm.
243 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
248 static inline int ir_has_irg_ref(const ir_node *node)
250 return is_Block(node) || is_Bad(node) || is_Anchor(node);
253 static inline ir_node *get_nodes_block_(const ir_node *node)
255 assert(!is_Block(node));
256 return get_irn_n(node, -1);
259 static inline ir_graph *get_irn_irg_(const ir_node *node)
261 if (! is_Block(node))
262 node = get_nodes_block(node);
263 assert(ir_has_irg_ref(node));
264 return node->attr.irg.irg;
268 * Gets the visited counter of a node.
269 * Intern version for libFirm.
271 static inline ir_visited_t get_irn_visited_(const ir_node *node)
273 return node->visited;
277 * Sets the visited counter of a node.
278 * Intern version for libFirm.
280 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
282 node->visited = visited;
286 * Mark a node as visited in a graph.
287 * Intern version for libFirm.
289 static inline void mark_irn_visited_(ir_node *node)
291 node->visited = get_irn_irg(node)->visited;
295 * Returns non-zero if a node of was visited.
296 * Intern version for libFirm.
298 static inline int irn_visited_(const ir_node *node)
300 ir_graph *irg = get_irn_irg(node);
301 return node->visited >= irg->visited;
304 static inline int irn_visited_else_mark_(ir_node *node)
306 if (irn_visited_(node))
308 mark_irn_visited_(node);
313 * Sets the link of a node.
314 * Intern version of libFirm.
316 static inline void set_irn_link_(ir_node *node, void *link)
322 * Returns the link of a node.
323 * Intern version of libFirm.
325 static inline void *get_irn_link_(const ir_node *node)
327 assert(is_ir_node_(node));
332 * Returns whether the node _always_ must be pinned.
333 * I.e., the node is not floating after global cse.
335 * Intern version of libFirm.
337 static inline op_pin_state get_irn_pinned_(const ir_node *node)
340 assert(is_ir_node_(node));
342 state = get_op_pinned_(get_irn_op_(node));
344 if (state >= op_pin_state_exc_pinned)
345 return (op_pin_state)node->attr.except.pin_state;
350 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
352 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
353 return get_irn_pinned(node);
354 return op_pin_state_pinned;
357 static inline int is_unop_(const ir_node *node)
359 assert(is_ir_node_(node));
360 return (node->op->opar == oparity_unary);
363 static inline int is_binop_(const ir_node *node)
365 assert(is_ir_node_(node));
366 return (node->op->opar == oparity_binary);
369 static inline int is_SymConst_addr_ent_(const ir_node *node)
371 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
375 * Get the predecessor block.
377 * Returns the block corresponding to the predecessor pos.
379 * If we encounter the Bad node, this function does not return the Start block,
382 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
384 ir_node *res = get_Block_cfgpred(node, pos);
386 /* must return a Bad with mode_BB! */
387 ir_graph *irg = get_irn_irg(node);
388 return new_r_Bad(irg, mode_BB);
390 return get_nodes_block(res);
394 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
396 assert(is_Block(node));
397 return node->attr.block.block_visited;
400 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
402 assert(is_Block(node));
403 node->attr.block.block_visited = visit;
406 static inline ir_graph *get_Block_irg_(const ir_node *block)
408 assert(is_Block(block));
409 return block->attr.irg.irg;
412 static inline void mark_Block_block_visited_(ir_node *node)
414 ir_graph *irg = get_Block_irg(node);
415 node->attr.block.block_visited = get_irg_block_visited(irg);
418 static inline int Block_block_visited_(const ir_node *node)
420 ir_graph *irg = get_Block_irg(node);
421 return node->attr.block.block_visited >= get_irg_block_visited(irg);
424 static inline int is_Const_null_(const ir_node *node)
426 return tarval_is_null(get_Const_tarval_(node));
429 static inline int is_Const_one_(const ir_node *node)
431 return tarval_is_one(get_Const_tarval_(node));
434 static inline int is_Const_all_one_(const ir_node *node)
436 return tarval_is_all_one(get_Const_tarval_(node));
439 static inline int is_irn_forking_(const ir_node *node)
441 return is_op_forking(get_irn_op_(node));
444 static inline ir_type *get_irn_type_attr_(ir_node *node)
446 return get_irn_op_(node)->ops.get_type_attr(node);
449 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
451 return get_irn_op_(node)->ops.get_entity_attr(node);
454 static inline int is_irn_constlike_(const ir_node *node)
456 return is_op_constlike(get_irn_op_(node));
459 static inline int is_irn_keep_(const ir_node *node)
461 return is_op_keep(get_irn_op_(node));
464 static inline int is_irn_start_block_placed_(const ir_node *node)
466 return is_op_start_block_placed(get_irn_op_(node));
469 static inline int is_irn_cse_neutral_(const ir_node *node)
471 return is_op_cse_neutral(get_irn_op_(node));
474 static inline void *get_irn_generic_attr_(ir_node *node)
479 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
484 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
489 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
495 * Sets the Phi list of a block.
497 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
499 assert(is_Block_(block));
500 assert(phi == NULL || is_Phi_(phi));
501 block->attr.block.phis = phi;
505 * Returns the link of a node.
506 * Intern version of libFirm.
508 static inline ir_node *get_Block_phis_(const ir_node *block)
510 assert(is_Block_(block));
511 return block->attr.block.phis;
514 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
516 assert(is_Phi_(phi));
517 phi->attr.phi.next = next;
520 static inline ir_node *get_Phi_next_(const ir_node *phi)
522 assert(is_Phi_(phi));
523 return phi->attr.phi.next;
526 /** Add a Phi node to the list of Block Phi's. */
527 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
529 assert(is_Block_(block));
530 set_Phi_next_(phi, get_Block_phis_(block));
531 set_Block_phis_(block, phi);
534 /** Get the Block mark (single bit). */
535 static inline unsigned get_Block_mark_(const ir_node *block)
537 assert(is_Block_(block));
538 return block->attr.block.marked;
541 /** Set the Block mark (single bit). */
542 static inline void set_Block_mark_(ir_node *block, unsigned mark)
544 assert(is_Block_(block));
545 block->attr.block.marked = mark;
548 /** Returns non-zero if a node is a routine parameter. */
549 static inline int is_arg_Proj_(const ir_node *node)
553 node = get_Proj_pred(node);
556 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
559 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
561 return table->n_entries;
564 static inline ir_switch_table_entry *ir_switch_table_get_entry(
565 ir_switch_table *table, size_t entry)
567 assert(entry < table->n_entries);
568 return &table->entries[entry];
571 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
572 const ir_switch_table *table, size_t entry)
574 assert(entry < table->n_entries);
575 return &table->entries[entry];
578 void ir_register_getter_ops(void);
581 * because firm keepalive edges are a broken concept, we have to make sure that
582 * nodes which are only held by a keepalive edges are never moved again.
583 * This function returns true in this case.
585 bool only_used_by_keepalive(const ir_node *node);