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
26 #ifndef FIRM_IR_IRNODE_T_H
27 #define FIRM_IR_IRNODE_T_H
32 #include "irgraph_t.h"
35 #include "iredges_t.h"
38 * Returns the array with the ins. The content of the array may not be
40 * Note that this function returns the whole in array including the
41 * block predecessor. So, it is NOT symmetric with set_irn_in().
43 ir_node **get_irn_in(const ir_node *node);
46 * The amount of additional space for custom data to be allocated upon creating a new node.
48 extern unsigned firm_add_node_size;
51 * Sets the get_type_attr operation for an ir_op_ops.
53 * @param code the opcode for the default operation
54 * @param ops the operations initialized
59 ir_op_ops *firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops);
62 * Sets the get_entity_attr operation for an ir_op_ops.
64 * @param code the opcode for the default operation
65 * @param ops the operations initialized
70 ir_op_ops *firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops);
73 * Returns an array with the predecessors of the Block. Depending on
74 * the implementation of the graph data structure this can be a copy of
75 * the internal representation of predecessors as well as the internal
76 * array itself. Therefore writing to this array might obstruct the IR.
78 ir_node **get_Block_cfgpred_arr(ir_node *node);
80 /*-------------------------------------------------------------------*/
81 /* These function are most used in libfirm. Give them as static */
82 /* functions so they can be inlined. */
83 /*-------------------------------------------------------------------*/
86 * Checks whether a pointer points to a ir node.
87 * Intern version for libFirm.
89 static inline int is_ir_node_(const void *thing)
91 return (get_kind(thing) == k_ir_node);
95 * Gets the op of a node.
96 * Intern version for libFirm.
98 static inline ir_op *get_irn_op_(const ir_node *node)
104 static inline void set_irn_op_(ir_node *node, ir_op *op)
110 /** Copies all attributes stored in the old node to the new node.
111 Assumes both have the same opcode and sufficient size. */
112 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
115 ir_op *op = get_irn_op_(old_node);
117 /* must always exist */
118 op->ops.copy_attr(irg, old_node, new_node);
122 * Gets the opcode of a node.
123 * Intern version for libFirm.
125 static inline unsigned get_irn_opcode_(const ir_node *node)
127 assert(k_ir_node == get_kind(node));
129 return node->op->code;
133 * Returns the number of predecessors without the block predecessor.
134 * Intern version for libFirm.
136 static inline int get_irn_arity_(const ir_node *node)
138 return (int)(ARR_LEN(node->in) - 1);
142 * Intern version for libFirm.
144 static inline ir_node *get_irn_n_(const ir_node *node, int n)
148 assert(-1 <= n && n < get_irn_arity_(node));
150 nn = node->in[n + 1];
151 if (nn->op != op_Id) return nn;
153 return (node->in[n + 1] = skip_Id(nn));
157 * returns a hash value for a node
159 static inline unsigned hash_irn(const ir_node *node)
161 return (unsigned) get_irn_idx(node);
164 static inline int get_irn_deps_(const ir_node *node)
166 return node->deps ? (int)ARR_LEN(node->deps) : 0;
169 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
171 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
172 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
173 return node->deps[pos];
176 /* forward declaration outside iredges_t.h to avoid circular include problems */
177 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);
179 static inline void set_irn_dep_(ir_node *node, int pos, ir_node *dep)
183 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
184 assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
185 old = node->deps[pos];
186 node->deps[pos] = dep;
187 edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
191 static inline int get_irn_ins_or_deps_(const ir_node *irn)
193 return get_irn_deps_(irn) + get_irn_arity_(irn);
196 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
198 int n_in = get_irn_arity(irn);
199 return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
203 * Gets the mode of a node.
204 * Intern version for libFirm.
206 static inline ir_mode *get_irn_mode_(const ir_node *node)
213 * Sets the mode of a node.
214 * Intern version of libFirm.
216 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
222 static inline int ir_has_irg_ref(const ir_node *node)
224 return is_Block(node) || is_Bad(node) || is_Anchor(node);
227 static inline ir_graph *get_irn_irg_(const ir_node *node)
230 * Do not use get_nodes_block() here, because this
231 * will check the pinned state.
232 * However even a 'wrong' block is always in the proper irg.
234 if (! is_Block(node))
235 node = get_irn_n(node, -1);
236 assert(ir_has_irg_ref(node));
237 return node->attr.irg.irg;
240 static inline ir_node *get_nodes_block_(const ir_node *node)
242 assert(!is_Block(node));
243 return get_irn_n(node, -1);
247 * Gets the visited counter of a node.
248 * Intern version for libFirm.
250 static inline ir_visited_t get_irn_visited_(const ir_node *node)
253 return node->visited;
257 * Sets the visited counter of a node.
258 * Intern version for libFirm.
260 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
263 node->visited = visited;
267 * Mark a node as visited in a graph.
268 * Intern version for libFirm.
270 static inline void mark_irn_visited_(ir_node *node)
272 node->visited = get_irn_irg(node)->visited;
276 * Returns non-zero if a node of was visited.
277 * Intern version for libFirm.
279 static inline int irn_visited_(const ir_node *node)
281 ir_graph *irg = get_irn_irg(node);
282 return node->visited >= irg->visited;
285 static inline int irn_visited_else_mark_(ir_node *node)
287 if (irn_visited_(node))
289 mark_irn_visited_(node);
294 * Sets the link of a node.
295 * Intern version of libFirm.
297 static inline void set_irn_link_(ir_node *node, void *link)
304 * Returns the link of a node.
305 * Intern version of libFirm.
307 static inline void *get_irn_link_(const ir_node *node)
309 assert(node && is_ir_node_(node));
314 * Returns whether the node _always_ must be pinned.
315 * I.e., the node is not floating after global cse.
317 * Intern version of libFirm.
319 static inline op_pin_state get_irn_pinned_(const ir_node *node)
322 assert(node && is_ir_node_(node));
324 state = get_op_pinned_(get_irn_op_(node));
326 if (state >= op_pin_state_exc_pinned)
327 return (op_pin_state)node->attr.except.pin_state;
332 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
334 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
335 return get_irn_pinned(node);
336 return op_pin_state_pinned;
339 /* include generated code */
340 #include "gen_irnode.h"
342 static inline int is_unop_(const ir_node *node)
344 assert(node && is_ir_node_(node));
345 return (node->op->opar == oparity_unary);
348 static inline int is_binop_(const ir_node *node)
350 assert(node && is_ir_node_(node));
351 return (node->op->opar == oparity_binary);
354 static inline int is_strictConv_(const ir_node *node)
356 return is_Conv_(node) && get_Conv_strict(node);
359 static inline int is_SymConst_addr_ent_(const ir_node *node)
361 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
364 static inline int get_Block_n_cfgpreds_(const ir_node *node)
366 assert(is_Block_(node));
367 return get_irn_arity_(node);
370 static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
372 assert(is_Block_(node));
373 return get_irn_n_(node, pos);
376 /* Get the predecessor block.
378 * Returns the block corresponding to the predecessor pos.
380 * There are several ambiguities we resolve with this function:
381 * - The direct predecessor can be a Proj, which is not pinned.
382 * We walk from the predecessor to the next pinned node
383 * (skip_Proj) and return the block that node is in.
384 * - If we encounter the Bad node, this function does not return
385 * the Start block, but the Bad node.
387 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
389 ir_node *res = get_Block_cfgpred(node, pos);
391 /* must return a Bad with mode_BB! */
392 ir_graph *irg = get_irn_irg(node);
393 return new_r_Bad(irg, mode_BB);
395 return get_nodes_block(skip_Proj(res));
399 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
401 assert(is_Block(node));
402 return node->attr.block.block_visited;
405 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
407 assert(is_Block(node));
408 node->attr.block.block_visited = visit;
411 static inline void mark_Block_block_visited_(ir_node *node)
413 ir_graph *irg = get_Block_irg(node);
414 node->attr.block.block_visited = get_irg_block_visited(irg);
417 static inline int Block_block_visited_(const ir_node *node)
419 ir_graph *irg = get_Block_irg(node);
420 return node->attr.block.block_visited >= get_irg_block_visited(irg);
423 static inline ir_graph *get_Block_irg_(const ir_node *block)
425 assert(is_Block(block));
426 return block->attr.irg.irg;
429 static inline ir_tarval *get_Const_tarval_(const ir_node *node)
431 assert(get_irn_op_(node) == op_Const);
432 return node->attr.con.tarval;
435 static inline int is_Const_null_(const ir_node *node)
437 return tarval_is_null(get_Const_tarval_(node));
440 static inline int is_Const_one_(const ir_node *node)
442 return tarval_is_one(get_Const_tarval_(node));
445 static inline int is_Const_all_one_(const ir_node *node)
447 return tarval_is_all_one(get_Const_tarval_(node));
450 static inline int is_irn_forking_(const ir_node *node)
452 return is_op_forking(get_irn_op_(node));
455 static inline ir_type *get_irn_type_attr_(ir_node *node)
457 return get_irn_op_(node)->ops.get_type_attr(node);
460 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
462 return get_irn_op_(node)->ops.get_entity_attr(node);
465 static inline int is_irn_constlike_(const ir_node *node)
467 return is_op_constlike(get_irn_op_(node));
470 static inline int is_irn_always_opt_(const ir_node *node)
472 return is_op_always_opt(get_irn_op_(node));
475 static inline int is_irn_keep_(const ir_node *node)
477 return is_op_keep(get_irn_op_(node));
480 static inline int is_irn_start_block_placed_(const ir_node *node)
482 return is_op_start_block_placed(get_irn_op_(node));
485 static inline int is_irn_machine_op_(const ir_node *node)
487 return is_op_machine(get_irn_op_(node));
490 static inline int is_irn_machine_operand_(const ir_node *node)
492 return is_op_machine_operand(get_irn_op_(node));
495 static inline int is_irn_machine_user_(const ir_node *node, unsigned n)
497 return is_op_machine_user(get_irn_op_(node), n);
500 static inline int is_irn_cse_neutral_(const ir_node *node)
502 return is_op_cse_neutral(get_irn_op_(node));
505 static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
507 assert(get_irn_op_(node) == op_Cond);
508 return node->attr.cond.jmp_pred;
511 static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
513 assert(get_irn_op_(node) == op_Cond);
514 node->attr.cond.jmp_pred = pred;
517 static inline void *get_irn_generic_attr_(ir_node *node)
522 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
527 static inline unsigned get_irn_idx_(const ir_node *node)
529 return node->node_idx;
532 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
537 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
543 * Sets the Phi list of a block.
545 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
547 assert(is_Block_(block));
548 assert(phi == NULL || is_Phi_(phi));
549 block->attr.block.phis = phi;
553 * Returns the link of a node.
554 * Intern version of libFirm.
556 static inline ir_node *get_Block_phis_(const ir_node *block)
558 assert(is_Block_(block));
559 return block->attr.block.phis;
562 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
564 assert(is_Phi_(phi));
565 phi->attr.phi.next = next;
568 static inline ir_node *get_Phi_next_(const ir_node *phi)
570 assert(is_Phi_(phi));
571 return phi->attr.phi.next;
574 /** Add a Phi node to the list of Block Phi's. */
575 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
577 assert(is_Block_(block));
578 set_Phi_next_(phi, get_Block_phis_(block));
579 set_Block_phis_(block, phi);
582 /** Get the Block mark (single bit). */
583 static inline unsigned get_Block_mark_(const ir_node *block)
585 assert(is_Block_(block));
586 return block->attr.block.marked;
589 /** Set the Block mark (single bit). */
590 static inline void set_Block_mark_(ir_node *block, unsigned mark)
592 assert(is_Block_(block));
593 block->attr.block.marked = mark;
596 /** Returns non-zero if a node is a routine parameter. */
597 static inline int is_arg_Proj_(const ir_node *node)
601 node = get_Proj_pred(node);
604 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
607 /** initialize ir_node module */
608 void init_irnode(void);
610 /* this section MUST contain all inline functions */
611 #define is_ir_node(thing) is_ir_node_(thing)
612 #define get_irn_arity(node) get_irn_arity_(node)
613 #define get_irn_n(node, n) get_irn_n_(node, n)
614 #define get_irn_mode(node) get_irn_mode_(node)
615 #define set_irn_mode(node, mode) set_irn_mode_(node, mode)
616 #define get_irn_irg(node) get_irn_irg_(node)
617 #define get_nodes_block(node) get_nodes_block_(node)
618 #define get_irn_op(node) get_irn_op_(node)
619 #define set_irn_op(node, op) set_irn_op_(node, op)
620 #define get_irn_opcode(node) get_irn_opcode_(node)
621 #define get_irn_visited(node) get_irn_visited_(node)
622 #define set_irn_visited(node, v) set_irn_visited_(node, v)
623 #define mark_irn_visited(node) mark_irn_visited_(node)
624 #define irn_visited(node) irn_visited_(node)
625 #define irn_visited_else_mark(node) irn_visited_else_mark_(node)
626 #define set_irn_link(node, link) set_irn_link_(node, link)
627 #define get_irn_link(node) get_irn_link_(node)
628 #define get_irn_pinned(node) get_irn_pinned_(node)
629 #define is_irn_pinned_in_irg(node) is_irn_pinned_in_irg_(node)
630 #define is_unop(node) is_unop_(node)
631 #define is_binop(node) is_binop_(node)
632 #define is_Proj(node) is_Proj_(node)
633 #define is_Phi(node) is_Phi_(node)
634 #define is_strictConv(node) is_strictConv_(node)
635 #define is_SymConst_addr_ent(node) is_SymConst_addr_ent_(node)
636 #define get_Block_n_cfgpreds(node) get_Block_n_cfgpreds_(node)
637 #define get_Block_cfgpred(node, pos) get_Block_cfgpred_(node, pos)
638 #define get_Block_cfgpred_block(node, pos) get_Block_cfgpred_block_(node, pos)
639 #define get_Block_block_visited(node) get_Block_block_visited_(node)
640 #define set_Block_block_visited(node, visit) set_Block_block_visited_(node, visit)
641 #define mark_Block_block_visited(node) mark_Block_block_visited_(node)
642 #define Block_block_visited(node) Block_block_visited_(node)
643 #define get_Block_irg(block) get_Block_irg_(block)
644 #define get_Const_tarval(node) get_Const_tarval_(node)
645 #define is_Const_null(node) is_Const_null_(node)
646 #define is_Const_one(node) is_Const_one_(node)
647 #define is_Const_all_one(node) is_Const_all_one_(node)
648 #define is_irn_forking(node) is_irn_forking_(node)
649 #define copy_node_attr(irg,oldn,newn) copy_node_attr_(irg,oldn,newn)
650 #define get_irn_type(node) get_irn_type_(node)
651 #define get_irn_type_attr(node) get_irn_type_attr_(node)
652 #define get_irn_entity_attr(node) get_irn_entity_attr_(node)
653 #define is_irn_constlike(node) is_irn_constlike_(node)
654 #define is_irn_always_opt(node) is_irn_always_opt_(node)
655 #define is_irn_keep(node) is_irn_keep_(node)
656 #define is_irn_start_block_placed(node) is_irn_start_block_placed_(node)
657 #define is_irn_machine_op(node) is_irn_machine_op_(node)
658 #define is_irn_machine_operand(node) is_irn_machine_operand_(node)
659 #define is_irn_machine_user(node, n) is_irn_machine_user_(node, n)
660 #define is_irn_cse_neutral(node) is_irn_cse_neutral_(node)
661 #define get_Cond_jmp_pred(node) get_Cond_jmp_pred_(node)
662 #define set_Cond_jmp_pred(node, pred) set_Cond_jmp_pred_(node, pred)
663 #define get_irn_generic_attr(node) get_irn_generic_attr_(node)
664 #define get_irn_generic_attr_const(node) get_irn_generic_attr_const_(node)
665 #define get_irn_idx(node) get_irn_idx_(node)
667 #define get_irn_deps(node) get_irn_deps_(node)
668 #define set_irn_dep(node, pos, dep) set_irn_dep_(node, pos, dep)
669 #define get_irn_dep(node, pos) get_irn_dep_(node, pos)
671 #define get_irn_ins_or_deps(node) get_irn_ins_or_deps_(node)
672 #define get_irn_in_or_dep(node, pos) get_irn_in_or_dep_(node, pos)
674 #define get_irn_dbg_info(node) get_irn_dbg_info_(node)
675 #define set_irn_dbg_info(node, db) set_irn_dbg_info_(node, db)
677 #define set_Block_phis(block, phi) set_Block_phis_(block, phi)
678 #define get_Block_phis(block) get_Block_phis_(block)
679 #define add_Block_phi(block, phi) add_Block_phi_(block, phi)
680 #define get_Block_mark(block) get_Block_mark_(block)
681 #define set_Block_mark(block, mark) set_Block_mark_(block, mark)
683 #define set_Phi_next(node, phi) set_Phi_next_(node, phi)
684 #define get_Phi_next(node) get_Phi_next_(node)
686 #define is_arg_Proj(node) is_arg_Proj_(node)