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 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(ir_opcode code, ir_op_ops *ops);
62 * Sets the get_type_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_type_attr(ir_opcode code, ir_op_ops *ops);
73 * Sets the get_entity_attr operation for an ir_op_ops.
75 * @param code the opcode for the default operation
76 * @param ops the operations initialized
81 ir_op_ops *firm_set_default_get_entity_attr(ir_opcode code, ir_op_ops *ops);
84 * Returns an array with the predecessors of the Block. Depending on
85 * the implementation of the graph data structure this can be a copy of
86 * the internal representation of predecessors as well as the internal
87 * array itself. Therefore writing to this array might obstruct the IR.
89 ir_node **get_Block_cfgpred_arr(ir_node *node);
91 /*-------------------------------------------------------------------*/
92 /* These function are most used in libfirm. Give them as static */
93 /* functions so they can be inlined. */
94 /*-------------------------------------------------------------------*/
97 * Checks whether a pointer points to a ir node.
98 * Intern version for libFirm.
100 static inline int _is_ir_node(const void *thing)
102 return (get_kind(thing) == k_ir_node);
106 * Gets the op of a node.
107 * Intern version for libFirm.
109 static inline ir_op *_get_irn_op(const ir_node *node)
115 static inline void _set_irn_op(ir_node *node, ir_op *op)
121 /** Copies all attributes stored in the old node to the new node.
122 Assumes both have the same opcode and sufficient size. */
123 static inline void _copy_node_attr(ir_graph *irg, const ir_node *old_node,
126 ir_op *op = _get_irn_op(old_node);
128 /* must always exist */
129 op->ops.copy_attr(irg, old_node, new_node);
133 * Gets the opcode of a node.
134 * Intern version for libFirm.
136 static inline unsigned _get_irn_opcode(const ir_node *node)
138 assert(k_ir_node == get_kind(node));
140 return node->op->code;
144 * Returns the number of predecessors without the block predecessor.
145 * Intern version for libFirm.
147 static inline int _get_irn_arity(const ir_node *node)
149 return ARR_LEN(node->in) - 1;
153 * Intern version for libFirm.
155 static inline ir_node *_get_irn_n(const ir_node *node, int n)
159 assert(-1 <= n && n < _get_irn_arity(node));
161 nn = node->in[n + 1];
163 /* only block and Anchor inputs are allowed to be NULL */
164 assert((is_Anchor(node) || n == -1) && "NULL input of a node");
167 if (nn->op != op_Id) return nn;
169 return (node->in[n + 1] = skip_Id(nn));
173 * returns a hash value for a node
175 static inline unsigned hash_irn(const ir_node *node)
177 return (unsigned) get_irn_idx(node);
180 static inline int _get_irn_deps(const ir_node *node) {
181 return node->deps ? ARR_LEN(node->deps) : 0;
184 static inline ir_node *_get_irn_dep(const ir_node *node, int pos) {
185 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
186 assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
187 return node->deps[pos];
190 /* forward declaration outside iredges_t.h to avoid circular include problems */
191 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);
193 static inline void _set_irn_dep(ir_node *node, int pos, ir_node *dep)
197 assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
198 assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
199 old = node->deps[pos];
200 node->deps[pos] = dep;
201 edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
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)
227 * Sets the mode of a node.
228 * Intern version of libFirm.
230 static inline void _set_irn_mode(ir_node *node, ir_mode *mode)
236 static inline int ir_has_irg_ref(const ir_node *node)
238 return is_Block(node) || is_Bad(node) || is_Anchor(node);
241 static inline ir_graph *_get_irn_irg(const ir_node *node)
244 * Do not use get_nodes_block() here, because this
245 * will check the pinned state.
246 * However even a 'wrong' block is always in the proper irg.
248 if (! is_Block(node))
249 node = get_irn_n(node, -1);
250 assert(ir_has_irg_ref(node));
251 return node->attr.irg.irg;
254 static inline ir_node *_get_nodes_block(const ir_node *node)
256 assert(!is_Block(node));
257 return get_irn_n(node, -1);
261 * Gets the visited counter of a node.
262 * Intern version for libFirm.
264 static inline ir_visited_t _get_irn_visited(const ir_node *node)
267 return node->visited;
271 * Sets the visited counter of a node.
272 * Intern version for libFirm.
274 static inline void _set_irn_visited(ir_node *node, ir_visited_t visited)
277 node->visited = visited;
281 * Mark a node as visited in a graph.
282 * Intern version for libFirm.
284 static inline void _mark_irn_visited(ir_node *node)
286 node->visited = get_irn_irg(node)->visited;
290 * Returns non-zero if a node of was visited.
291 * Intern version for libFirm.
293 static inline int _irn_visited(const ir_node *node)
295 ir_graph *irg = get_irn_irg(node);
296 return node->visited >= irg->visited;
299 static inline int _irn_visited_else_mark(ir_node *node)
301 if (_irn_visited(node))
303 _mark_irn_visited(node);
308 * Sets the link of a node.
309 * Intern version of libFirm.
311 static inline void _set_irn_link(ir_node *node, void *link)
318 * Returns the link of a node.
319 * Intern version of libFirm.
321 static inline void *_get_irn_link(const ir_node *node)
323 assert(node && _is_ir_node(node));
328 * Returns whether the node _always_ must be pinned.
329 * I.e., the node is not floating after global cse.
331 * Intern version of libFirm.
333 static inline op_pin_state _get_irn_pinned(const ir_node *node)
336 assert(node && _is_ir_node(node));
338 state = _get_op_pinned(_get_irn_op(node));
340 if (state >= op_pin_state_exc_pinned)
341 return node->attr.except.pin_state;
346 static inline op_pin_state _is_irn_pinned_in_irg(const ir_node *node)
348 if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
349 return get_irn_pinned(node);
350 return op_pin_state_pinned;
353 /* include generated code */
354 #include "gen_irnode.h"
356 static inline int _is_unop(const ir_node *node)
358 assert(node && _is_ir_node(node));
359 return (node->op->opar == oparity_unary);
362 static inline int _is_binop(const ir_node *node)
364 assert(node && _is_ir_node(node));
365 return (node->op->opar == oparity_binary);
368 static inline int _is_strictConv(const ir_node *node)
370 return _is_Conv(node) && get_Conv_strict(node);
373 static inline int _is_SymConst_addr_ent(const ir_node *node)
375 return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
378 static inline int _get_Block_n_cfgpreds(const ir_node *node)
380 assert(_is_Block(node));
381 return _get_irn_arity(node);
384 static inline ir_node *_get_Block_cfgpred(const ir_node *node, int pos)
386 assert(0 <= pos && pos < get_irn_arity(node));
387 assert(_is_Block(node));
388 return _get_irn_n(node, pos);
391 /* Get the predecessor block.
393 * Returns the block corresponding to the predecessor pos.
395 * There are several ambiguities we resolve with this function:
396 * - The direct predecessor can be a Proj, which is not pinned.
397 * We walk from the predecessor to the next pinned node
398 * (skip_Proj) and return the block that node is in.
399 * - If we encounter the Bad node, this function does not return
400 * the Start block, but the Bad node.
402 static inline ir_node *_get_Block_cfgpred_block(const ir_node *node, int pos)
404 ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
406 res = get_nodes_block(res);
410 static inline ir_visited_t _get_Block_block_visited(const ir_node *node)
412 assert(is_Block(node));
413 return node->attr.block.block_visited;
416 static inline void _set_Block_block_visited(ir_node *node, ir_visited_t visit)
418 assert(is_Block(node));
419 node->attr.block.block_visited = visit;
422 static inline void _mark_Block_block_visited(ir_node *node)
424 ir_graph *irg = get_Block_irg(node);
425 node->attr.block.block_visited = get_irg_block_visited(irg);
428 static inline int _Block_block_visited(const ir_node *node)
430 ir_graph *irg = get_Block_irg(node);
431 return node->attr.block.block_visited >= get_irg_block_visited(irg);
434 static inline ir_node *_set_Block_dead(ir_node *block)
436 assert(_get_irn_op(block) == op_Block);
437 block->attr.block.dom.dom_depth = -1;
438 block->attr.block.is_dead = 1;
442 static inline int _is_Block_dead(const ir_node *block)
444 ir_op *op = _get_irn_op(block);
449 assert(op == op_Block);
450 return block->attr.block.is_dead;
454 static inline ir_graph *_get_Block_irg(const ir_node *block)
456 assert(is_Block(block));
457 return block->attr.irg.irg;
460 static inline tarval *_get_Const_tarval(const ir_node *node) {
461 assert(_get_irn_op(node) == op_Const);
462 return node->attr.con.tarval;
465 static inline int _is_Const_null(const ir_node *node) {
466 return tarval_is_null(_get_Const_tarval(node));
469 static inline int _is_Const_one(const ir_node *node) {
470 return tarval_is_one(_get_Const_tarval(node));
473 static inline int _is_Const_all_one(const ir_node *node) {
474 return tarval_is_all_one(_get_Const_tarval(node));
477 static inline int _is_irn_forking(const ir_node *node) {
478 return is_op_forking(_get_irn_op(node));
481 static inline ir_type *_get_irn_type(ir_node *node) {
482 return _get_irn_op(node)->ops.get_type(node);
485 static inline ir_type *_get_irn_type_attr(ir_node *node) {
486 return _get_irn_op(node)->ops.get_type_attr(node);
489 static inline ir_entity *_get_irn_entity_attr(ir_node *node) {
490 return _get_irn_op(node)->ops.get_entity_attr(node);
493 static inline int _is_irn_constlike(const ir_node *node) {
494 return is_op_constlike(_get_irn_op(node));
497 static inline int _is_irn_always_opt(const ir_node *node) {
498 return is_op_always_opt(_get_irn_op(node));
501 static inline int _is_irn_keep(const ir_node *node) {
502 return is_op_keep(_get_irn_op(node));
505 static inline int _is_irn_start_block_placed(const ir_node *node) {
506 return is_op_start_block_placed(_get_irn_op(node));
509 static inline int _is_irn_machine_op(const ir_node *node) {
510 return is_op_machine(_get_irn_op(node));
513 static inline int _is_irn_machine_operand(const ir_node *node) {
514 return is_op_machine_operand(_get_irn_op(node));
517 static inline int _is_irn_machine_user(const ir_node *node, unsigned n) {
518 return is_op_machine_user(_get_irn_op(node), n);
521 static inline int _is_irn_cse_neutral(const ir_node *node) {
522 return is_op_cse_neutral(_get_irn_op(node));
525 static inline cond_jmp_predicate _get_Cond_jmp_pred(const ir_node *node) {
526 assert(_get_irn_op(node) == op_Cond);
527 return node->attr.cond.jmp_pred;
530 static inline void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
531 assert(_get_irn_op(node) == op_Cond);
532 node->attr.cond.jmp_pred = pred;
535 static inline void *_get_irn_generic_attr(ir_node *node) {
539 static inline const void *_get_irn_generic_attr_const(const ir_node *node) {
543 static inline unsigned _get_irn_idx(const ir_node *node) {
544 return node->node_idx;
547 static inline dbg_info *_get_irn_dbg_info(const ir_node *n) {
549 } /* get_irn_dbg_info */
551 static inline void _set_irn_dbg_info(ir_node *n, dbg_info *db) {
556 * Sets the Phi list of a block.
558 static inline void _set_Block_phis(ir_node *block, ir_node *phi)
560 assert(_is_Block(block));
561 assert(phi == NULL || _is_Phi(phi));
562 block->attr.block.phis = phi;
566 * Returns the link of a node.
567 * Intern version of libFirm.
569 static inline ir_node *_get_Block_phis(const ir_node *block)
571 assert(_is_Block(block));
572 return block->attr.block.phis;
575 static inline void _set_Phi_next(ir_node *phi, ir_node *next)
577 assert(_is_Phi(phi));
578 phi->attr.phi.next = next;
581 static inline ir_node *_get_Phi_next(const ir_node *phi)
583 assert(_is_Phi(phi));
584 return phi->attr.phi.next;
587 /** Add a Phi node to the list of Block Phi's. */
588 static inline void _add_Block_phi(ir_node *block, ir_node *phi)
590 _set_Phi_next(phi, _get_Block_phis(block));
591 _set_Block_phis(block, phi);
594 /** Get the Block mark (single bit). */
595 static inline unsigned _get_Block_mark(const ir_node *block)
597 assert(_is_Block(block));
598 return block->attr.block.marked;
601 /** Set the Block mark (single bit). */
602 static inline void _set_Block_mark(ir_node *block, unsigned mark)
604 assert(_is_Block(block));
605 block->attr.block.marked = mark;
608 /** Returns non-zero if a node is a routine parameter. */
609 static inline int _is_arg_Proj(const ir_node *node)
613 node = get_Proj_pred(node);
616 return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
619 /** initialize ir_node module */
620 void init_irnode(void);
622 /* this section MUST contain all inline functions */
623 #define is_ir_node(thing) _is_ir_node(thing)
624 #define get_irn_arity(node) _get_irn_arity(node)
625 #define get_irn_n(node, n) _get_irn_n(node, n)
626 #define get_irn_mode(node) _get_irn_mode(node)
627 #define set_irn_mode(node, mode) _set_irn_mode(node, mode)
628 #define get_irn_irg(node) _get_irn_irg(node)
629 #define get_nodes_block(node) _get_nodes_block(node)
630 #define get_irn_op(node) _get_irn_op(node)
631 #define set_irn_op(node, op) _set_irn_op(node, op)
632 #define get_irn_opcode(node) _get_irn_opcode(node)
633 #define get_irn_visited(node) _get_irn_visited(node)
634 #define set_irn_visited(node, v) _set_irn_visited(node, v)
635 #define mark_irn_visited(node) _mark_irn_visited(node)
636 #define irn_visited(node) _irn_visited(node)
637 #define irn_visited_else_mark(node) _irn_visited_else_mark(node)
638 #define set_irn_link(node, link) _set_irn_link(node, link)
639 #define get_irn_link(node) _get_irn_link(node)
640 #define get_irn_pinned(node) _get_irn_pinned(node)
641 #define is_irn_pinned_in_irg(node) _is_irn_pinned_in_irg(node)
642 #define is_unop(node) _is_unop(node)
643 #define is_binop(node) _is_binop(node)
644 #define is_Proj(node) _is_Proj(node)
645 #define is_Phi(node) _is_Phi(node)
646 #define is_strictConv(node) _is_strictConv(node)
647 #define is_SymConst_addr_ent(node) _is_SymConst_addr_ent(node)
648 #define get_Block_n_cfgpreds(node) _get_Block_n_cfgpreds(node)
649 #define get_Block_cfgpred(node, pos) _get_Block_cfgpred(node, pos)
650 #define get_Block_cfgpred_block(node, pos) _get_Block_cfgpred_block(node, pos)
651 #define get_Block_block_visited(node) _get_Block_block_visited(node)
652 #define set_Block_block_visited(node, visit) _set_Block_block_visited(node, visit)
653 #define mark_Block_block_visited(node) _mark_Block_block_visited(node)
654 #define Block_block_visited(node) _Block_block_visited(node)
655 #define set_Block_dead(block) _set_Block_dead(block)
656 #define is_Block_dead(block) _is_Block_dead(block)
657 #define get_Block_irg(block) _get_Block_irg(block)
658 #define get_Const_tarval(node) _get_Const_tarval(node)
659 #define is_Const_null(node) _is_Const_null(node)
660 #define is_Const_one(node) _is_Const_one(node)
661 #define is_Const_all_one(node) _is_Const_all_one(node)
662 #define is_irn_forking(node) _is_irn_forking(node)
663 #define copy_node_attr(irg,oldn,newn) _copy_node_attr(irg,oldn,newn)
664 #define get_irn_type(node) _get_irn_type(node)
665 #define get_irn_type_attr(node) _get_irn_type_attr(node)
666 #define get_irn_entity_attr(node) _get_irn_entity_attr(node)
667 #define is_irn_constlike(node) _is_irn_constlike(node)
668 #define is_irn_always_opt(node) _is_irn_always_opt(node)
669 #define is_irn_keep(node) _is_irn_keep(node)
670 #define is_irn_start_block_placed(node) _is_irn_start_block_placed(node)
671 #define is_irn_machine_op(node) _is_irn_machine_op(node)
672 #define is_irn_machine_operand(node) _is_irn_machine_operand(node)
673 #define is_irn_machine_user(node, n) _is_irn_machine_user(node, n)
674 #define is_irn_cse_neutral(node) _is_irn_cse_neutral(node)
675 #define get_Cond_jmp_pred(node) _get_Cond_jmp_pred(node)
676 #define set_Cond_jmp_pred(node, pred) _set_Cond_jmp_pred(node, pred)
677 #define get_irn_generic_attr(node) _get_irn_generic_attr(node)
678 #define get_irn_generic_attr_const(node) _get_irn_generic_attr_const(node)
679 #define get_irn_idx(node) _get_irn_idx(node)
681 #define get_irn_deps(node) _get_irn_deps(node)
682 #define set_irn_dep(node, pos, dep) _set_irn_dep(node, pos, dep)
683 #define get_irn_dep(node, pos) _get_irn_dep(node, pos)
685 #define get_irn_ins_or_deps(node) _get_irn_ins_or_deps(node)
686 #define get_irn_in_or_dep(node, pos) _get_irn_in_or_dep(node, pos)
688 #define get_irn_dbg_info(node) _get_irn_dbg_info(node)
689 #define set_irn_dbg_info(node, db) _set_irn_dbg_info(node, db)
691 #define set_Block_phis(block, phi) _set_Block_phis(block, phi)
692 #define get_Block_phis(block) _get_Block_phis(block)
693 #define add_Block_phi(block, phi) _add_Block_phi(block, phi)
694 #define get_Block_mark(block) _get_Block_mark(block)
695 #define set_Block_mark(block, mark) _set_Block_mark(block, mark)
697 #define set_Phi_next(node, phi) _set_Phi_next(node, phi)
698 #define get_Phi_next(node) _get_Phi_next(node)
700 #define is_arg_Proj(node) _is_arg_Proj(node)