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 Contains some useful function for the backend.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BEUTIL_H
27 #define FIRM_BE_BEUTIL_H
31 #include "firm_types.h"
37 typedef __int64 long64;
38 typedef unsigned __int64 ulong64;
41 #define ULL_FMT "ui64"
44 typedef long long long64;
45 typedef unsigned long long ulong64;
52 /* iterate over a list of ir_nodes linked by link field */
53 #define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
57 * This function always returns the same set.
59 pset *be_empty_set(void);
62 * Convenient block getter.
63 * Works also, if the given node is a block.
64 * @param irn The node.
65 * @return The block of the node, or the node itself, if the node is a
68 static inline ir_node *get_block(ir_node *irn)
70 return is_Block(irn) ? irn : get_nodes_block(irn);
73 static inline const ir_node *get_block_const(const ir_node *irn)
75 return is_Block(irn) ? irn : get_nodes_block(irn);
79 * Check, if a node produces or consumes a data value.
80 * If it does, it is significant for scheduling and register allocation.
81 * A node produces/consumes a data value, if one of its operands is of
82 * mode datab, or his retuning mode is of mode datab.
83 * @param irn The node to check for.
84 * @return 1, if the node is a data node, 0 if not.
86 static inline int is_data_node(const ir_node *irn)
90 /* If the node produces a data value, return immediately. */
91 if (mode_is_data(get_irn_mode(irn)))
94 /* else check, if it takes a data value, if that is so, return */
95 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
96 ir_node *op = get_irn_n(irn, i);
97 if (mode_is_data(get_irn_mode(op)))
101 /* Else the node does not produce/consume a data value */
106 * Clears the link fields of all nodes of the given graph.
107 * @param irg The graph.
109 void be_clear_links(ir_graph *irg);
112 * Dump a graph with schedule edges.
113 * @param irg The graph.
114 * @param suffix A suffix to its file name.
116 void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
119 * Dump a extended block graph with schedule edges.
120 * @param irg The graph.
121 * @param suffix A suffix to its file name.
123 void dump_ir_extblock_graph_sched(ir_graph *irg, const char *suffix);
126 * Dumps a graph and numbers all dumps.
127 * @param irg The graph
128 * @param suffix A suffix to its file name.
129 * @param dumper The dump function
131 void be_dump(ir_graph *irg, const char *suffix, void (*dumper)(ir_graph *, const char *));
134 * Returns the number of reachable nodes in an irg.
135 * @param irg The irg.
136 * @return The number of reachable nodes.
138 unsigned get_num_reachable_nodes(ir_graph *irg);
141 * Gets the Proj with number pn from irn.
143 ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
146 * Returns an array (an ARR_F) of the programs blocks in reverse postorder
147 * (note: caller has to free the memory with DEL_ARR_F after use;
148 * of course you can use ARR_LEN on the array too.)
150 ir_node **be_get_cfgpostorder(ir_graph *irg);
153 * Opens a file named base.ext with the mode mode.
155 FILE *be_ffopen(const char *base, const char *ext, const char *mode);
158 * convenience function to return the first successor block
159 * (it is often known that there is exactly 1 successor anyway)
161 ir_node *get_first_block_succ(const ir_node *block);