2 * This file is part of libFirm.
3 * Copyright (C) 2012 University of Karlsruhe.
8 * @brief Representation of an intermediate operation -- private header.
9 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
11 #ifndef FIRM_IR_IRNODE_T_H
12 #define FIRM_IR_IRNODE_T_H
17 #include "irgraph_t.h"
20 #include "iredges_t.h"
22 /* This section MUST come first, so the inline functions get used in this header. */
23 #define is_ir_node(thing) is_ir_node_(thing)
24 #define get_irn_arity(node) get_irn_arity_(node)
25 #define get_irn_n(node, n) get_irn_n_(node, n)
26 #define get_irn_mode(node) get_irn_mode_(node)
27 #define set_irn_mode(node, mode) set_irn_mode_(node, mode)
28 #define get_irn_irg(node) get_irn_irg_(node)
29 #define get_nodes_block(node) get_nodes_block_(node)
30 #define get_irn_op(node) get_irn_op_(node)
31 #define set_irn_op(node, op) set_irn_op_(node, op)
32 #define get_irn_opcode(node) get_irn_opcode_(node)
33 #define get_irn_visited(node) get_irn_visited_(node)
34 #define set_irn_visited(node, v) set_irn_visited_(node, v)
35 #define mark_irn_visited(node) mark_irn_visited_(node)
36 #define irn_visited(node) irn_visited_(node)
37 #define irn_visited_else_mark(node) irn_visited_else_mark_(node)
38 #define set_irn_link(node, link) set_irn_link_(node, link)
39 #define get_irn_link(node) get_irn_link_(node)
40 #define get_irn_pinned(node) get_irn_pinned_(node)
41 #define is_irn_pinned_in_irg(node) is_irn_pinned_in_irg_(node)
42 #define is_unop(node) is_unop_(node)
43 #define is_binop(node) is_binop_(node)
44 #define is_SymConst_addr_ent(node) is_SymConst_addr_ent_(node)
45 #define get_Block_n_cfgpreds(node) get_Block_n_cfgpreds_(node)
46 #define get_Block_cfgpred(node, pos) get_Block_cfgpred_(node, pos)
47 #define get_Block_cfgpred_block(node, pos) get_Block_cfgpred_block_(node, pos)
48 #define get_Block_block_visited(node) get_Block_block_visited_(node)
49 #define set_Block_block_visited(node, visit) set_Block_block_visited_(node, visit)
50 #define mark_Block_block_visited(node) mark_Block_block_visited_(node)
51 #define Block_block_visited(node) Block_block_visited_(node)
52 #define get_Block_irg(block) get_Block_irg_(block)
53 #define is_Const_null(node) is_Const_null_(node)
54 #define is_Const_one(node) is_Const_one_(node)
55 #define is_Const_all_one(node) is_Const_all_one_(node)
56 #define is_irn_forking(node) is_irn_forking_(node)
57 #define copy_node_attr(irg,oldn,newn) copy_node_attr_(irg,oldn,newn)
58 #define get_irn_type(node) get_irn_type_(node)
59 #define get_irn_type_attr(node) get_irn_type_attr_(node)
60 #define get_irn_entity_attr(node) get_irn_entity_attr_(node)
61 #define is_irn_constlike(node) is_irn_constlike_(node)
62 #define is_irn_keep(node) is_irn_keep_(node)
63 #define is_irn_start_block_placed(node) is_irn_start_block_placed_(node)
64 #define is_irn_cse_neutral(node) is_irn_cse_neutral_(node)
65 #define get_irn_generic_attr(node) get_irn_generic_attr_(node)
66 #define get_irn_generic_attr_const(node) get_irn_generic_attr_const_(node)
67 #define get_irn_idx(node) get_irn_idx_(node)
69 #define get_irn_deps(node) get_irn_deps_(node)
70 #define get_irn_dep(node, pos) get_irn_dep_(node, pos)
72 #define get_irn_ins_or_deps(node) get_irn_ins_or_deps_(node)
73 #define get_irn_in_or_dep(node, pos) get_irn_in_or_dep_(node, pos)
75 #define get_irn_dbg_info(node) get_irn_dbg_info_(node)
76 #define set_irn_dbg_info(node, db) set_irn_dbg_info_(node, db)
78 #define set_Block_phis(block, phi) set_Block_phis_(block, phi)
79 #define get_Block_phis(block) get_Block_phis_(block)
80 #define add_Block_phi(block, phi) add_Block_phi_(block, phi)
81 #define get_Block_mark(block) get_Block_mark_(block)
82 #define set_Block_mark(block, mark) set_Block_mark_(block, mark)
84 #define set_Phi_next(node, phi) set_Phi_next_(node, phi)
85 #define get_Phi_next(node) get_Phi_next_(node)
87 #define is_arg_Proj(node) is_arg_Proj_(node)
88 #define ir_switch_table_get_n_entries(table) ir_switch_table_get_n_entries_(table)
91 * Returns the array with the ins. The content of the array may not be
93 * Note that this function returns the whole in array including the
94 * block predecessor. So, it is NOT symmetric with set_irn_in().
96 ir_node **get_irn_in(const ir_node *node);
98 /*-------------------------------------------------------------------*/
99 /* These function are most used in libfirm. Give them as static */
100 /* functions so they can be inlined. */
101 /*-------------------------------------------------------------------*/
104 * Checks whether a pointer points to a ir node.
105 * Intern version for libFirm.
107 static inline int is_ir_node_(const void *thing)
109 return (get_kind(thing) == k_ir_node);
112 static inline unsigned get_irn_idx_(const ir_node *node)
114 return node->node_idx;
118 * Gets the op of a node.
119 * Intern version for libFirm.
121 static inline ir_op *get_irn_op_(const ir_node *node)
126 static inline void set_irn_op_(ir_node *node, ir_op *op)
131 /** Copies all attributes stored in the old node to the new node.
132 Assumes both have the same opcode and sufficient size. */
133 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
136 ir_op *op = get_irn_op_(old_node);
138 /* must always exist */
139 op->ops.copy_attr(irg, old_node, new_node);
143 * Gets the opcode of a node.
144 * Intern version for libFirm.
146 static inline unsigned get_irn_opcode_(const ir_node *node)
148 assert(k_ir_node == get_kind(node));
149 return node->op->code;
153 * Returns the number of predecessors without the block predecessor.
154 * Intern version for libFirm.
156 static inline int get_irn_arity_(const ir_node *node)
158 return (int)(ARR_LEN(node->in) - 1);
161 /* forward decl... */
162 #define is_Id(node) is_Id_(node)
163 static inline int is_Id_(const ir_node *node);
166 * Intern version for libFirm.
168 static inline ir_node *get_irn_n_(const ir_node *node, int n)
172 assert(-1 <= n && n < get_irn_arity_(node));
174 nn = node->in[n + 1];
175 if (!is_Id(nn)) return nn;
177 return (node->in[n + 1] = skip_Id(nn));
180 /* include generated code */
181 #include "gen_irnode.h"
184 * returns a hash value for a node
186 static inline unsigned hash_irn(const ir_node *node)
188 return (unsigned) get_irn_idx(node);
191 static inline int get_irn_deps_(const ir_node *node)
193 return node->deps ? (int)ARR_LEN(node->deps) : 0;
196 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
198 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
199 return node->deps[pos];
202 /* forward declaration outside iredges_t.h to avoid circular include problems */
203 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);
205 static inline int get_irn_ins_or_deps_(const ir_node *irn)
207 return get_irn_deps_(irn) + get_irn_arity_(irn);
210 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
212 int n_in = get_irn_arity(irn);
213 return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
217 * Gets the mode of a node.
218 * Intern version for libFirm.
220 static inline ir_mode *get_irn_mode_(const ir_node *node)
226 * Sets the mode of a node.
227 * Intern version of libFirm.
229 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
234 static inline int ir_has_irg_ref(const ir_node *node)
236 return is_Block(node) || is_Bad(node) || is_Anchor(node);
239 static inline ir_node *get_nodes_block_(const ir_node *node)
241 assert(!is_Block(node));
242 return get_irn_n(node, -1);
245 static inline ir_graph *get_irn_irg_(const ir_node *node)
247 if (! is_Block(node))
248 node = get_nodes_block(node);
249 assert(ir_has_irg_ref(node));
250 return node->attr.irg.irg;
254 * Gets the visited counter of a node.
255 * Intern version for libFirm.
257 static inline ir_visited_t get_irn_visited_(const ir_node *node)
259 return node->visited;
263 * Sets the visited counter of a node.
264 * Intern version for libFirm.
266 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
268 node->visited = visited;
272 * Mark a node as visited in a graph.
273 * Intern version for libFirm.
275 static inline void mark_irn_visited_(ir_node *node)
277 node->visited = get_irn_irg(node)->visited;
281 * Returns non-zero if a node of was visited.
282 * Intern version for libFirm.
284 static inline int irn_visited_(const ir_node *node)
286 ir_graph *irg = get_irn_irg(node);
287 return node->visited >= irg->visited;
290 static inline int irn_visited_else_mark_(ir_node *node)
292 if (irn_visited_(node))
294 mark_irn_visited_(node);
299 * Sets the link of a node.
300 * Intern version of libFirm.
302 static inline void set_irn_link_(ir_node *node, void *link)
308 * Returns the link of a node.
309 * Intern version of libFirm.
311 static inline void *get_irn_link_(const ir_node *node)
313 assert(is_ir_node_(node));
318 * Returns whether the node _always_ must be pinned.
319 * I.e., the node is not floating after global cse.
321 * Intern version of libFirm.
323 static inline op_pin_state get_irn_pinned_(const ir_node *node)
326 assert(is_ir_node_(node));
328 state = get_op_pinned_(get_irn_op_(node));
330 if (state >= op_pin_state_exc_pinned)
331 return (op_pin_state)node->attr.except.pin_state;
336 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
338 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
339 return get_irn_pinned(node);
340 return op_pin_state_pinned;
343 static inline int is_unop_(const ir_node *node)
345 assert(is_ir_node_(node));
346 return (node->op->opar == oparity_unary);
349 static inline int is_binop_(const ir_node *node)
351 assert(is_ir_node_(node));
352 return (node->op->opar == oparity_binary);
355 static inline int is_SymConst_addr_ent_(const ir_node *node)
357 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
361 * Get the predecessor block.
363 * Returns the block corresponding to the predecessor pos.
365 * If we encounter the Bad node, this function does not return the Start block,
368 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
370 ir_node *res = get_Block_cfgpred(node, pos);
372 /* must return a Bad with mode_BB! */
373 ir_graph *irg = get_irn_irg(node);
374 return new_r_Bad(irg, mode_BB);
376 return get_nodes_block(res);
380 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
382 assert(is_Block(node));
383 return node->attr.block.block_visited;
386 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
388 assert(is_Block(node));
389 node->attr.block.block_visited = visit;
392 static inline ir_graph *get_Block_irg_(const ir_node *block)
394 assert(is_Block(block));
395 return block->attr.irg.irg;
398 static inline void mark_Block_block_visited_(ir_node *node)
400 ir_graph *irg = get_Block_irg(node);
401 node->attr.block.block_visited = get_irg_block_visited(irg);
404 static inline int Block_block_visited_(const ir_node *node)
406 ir_graph *irg = get_Block_irg(node);
407 return node->attr.block.block_visited >= get_irg_block_visited(irg);
410 static inline int is_Const_null_(const ir_node *node)
412 return tarval_is_null(get_Const_tarval_(node));
415 static inline int is_Const_one_(const ir_node *node)
417 return tarval_is_one(get_Const_tarval_(node));
420 static inline int is_Const_all_one_(const ir_node *node)
422 return tarval_is_all_one(get_Const_tarval_(node));
425 static inline int is_irn_forking_(const ir_node *node)
427 return is_op_forking(get_irn_op_(node));
430 static inline ir_type *get_irn_type_attr_(ir_node *node)
432 return get_irn_op_(node)->ops.get_type_attr(node);
435 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
437 return get_irn_op_(node)->ops.get_entity_attr(node);
440 static inline int is_irn_constlike_(const ir_node *node)
442 return is_op_constlike(get_irn_op_(node));
445 static inline int is_irn_keep_(const ir_node *node)
447 return is_op_keep(get_irn_op_(node));
450 static inline int is_irn_start_block_placed_(const ir_node *node)
452 return is_op_start_block_placed(get_irn_op_(node));
455 static inline int is_irn_cse_neutral_(const ir_node *node)
457 return is_op_cse_neutral(get_irn_op_(node));
460 static inline void *get_irn_generic_attr_(ir_node *node)
465 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
470 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
475 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
481 * Sets the Phi list of a block.
483 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
485 assert(is_Block_(block));
486 assert(phi == NULL || is_Phi_(phi));
487 block->attr.block.phis = phi;
491 * Returns the link of a node.
492 * Intern version of libFirm.
494 static inline ir_node *get_Block_phis_(const ir_node *block)
496 assert(is_Block_(block));
497 return block->attr.block.phis;
500 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
502 assert(is_Phi_(phi));
503 phi->attr.phi.next = next;
506 static inline ir_node *get_Phi_next_(const ir_node *phi)
508 assert(is_Phi_(phi));
509 return phi->attr.phi.next;
512 /** Add a Phi node to the list of Block Phi's. */
513 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
515 assert(is_Block_(block));
516 set_Phi_next_(phi, get_Block_phis_(block));
517 set_Block_phis_(block, phi);
520 /** Get the Block mark (single bit). */
521 static inline unsigned get_Block_mark_(const ir_node *block)
523 assert(is_Block_(block));
524 return block->attr.block.marked;
527 /** Set the Block mark (single bit). */
528 static inline void set_Block_mark_(ir_node *block, unsigned mark)
530 assert(is_Block_(block));
531 block->attr.block.marked = mark;
534 /** Returns non-zero if a node is a routine parameter. */
535 static inline int is_arg_Proj_(const ir_node *node)
539 node = get_Proj_pred(node);
542 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
545 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
547 return table->n_entries;
550 static inline ir_switch_table_entry *ir_switch_table_get_entry(
551 ir_switch_table *table, size_t entry)
553 assert(entry < table->n_entries);
554 return &table->entries[entry];
557 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
558 const ir_switch_table *table, size_t entry)
560 assert(entry < table->n_entries);
561 return &table->entries[entry];
564 void ir_register_getter_ops(void);
567 * because firm keepalive edges are a broken concept, we have to make sure that
568 * nodes which are only held by a keepalive edges are never moved again.
569 * This function returns true in this case.
571 bool only_used_by_keepalive(const ir_node *node);