2 * Copyright (C) 1995-2007 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
29 #include "firm_config.h"
33 #include "firm_types.h"
38 /* iterate over a list of ir_nodes linked by link field */
39 #define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
43 * This function always returns the same set.
45 pset *be_empty_set(void);
47 /** Undefine this to disable debugging mode. */
51 * Convenient block getter.
52 * Works also, if the given node is a block.
53 * @param irn The node.
54 * @return The block of the node, or the node itself, if the node is a
57 static INLINE const ir_node *get_block(const ir_node *irn)
59 return is_Block(irn) ? irn : get_nodes_block(irn);
62 static INLINE int is_firm_be_mode(const ir_mode *mode)
64 return mode_is_data(mode);
68 * Check, if a node produces or consumes a data value.
69 * If it does, it is significant for scheduling and register allocation.
70 * A node produces/consumes a data value, if one of its operands is of
71 * mode datab, or his retuning mode is of mode datab.
72 * @param irn The node to check for.
73 * @return 1, if the node is a data node, 0 if not.
75 static INLINE int is_data_node(const ir_node *irn)
79 /* If the node produces a data value, return immediately. */
80 if (is_firm_be_mode(get_irn_mode(irn)))
83 /* else check, if it takes a data value, if that is so, return */
84 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
85 ir_node *op = get_irn_n(irn, i);
86 if (is_firm_be_mode(get_irn_mode(op)))
90 /* Else the node does not produce/consume a data value */
95 * Dump a vcg graph containing the controlflow graph, the schedule and
96 * allocated registers.
97 * @param irg The irg. Note that scheduling, register allocation must
98 * have been performed.
100 void dump_allocated_irg(arch_env_t *env, ir_graph *irg, char *suffix);
102 void be_clear_links(ir_graph *irg);
105 * Dump a graph with schedule edges.
106 * @param irg The graph.
107 * @param suffix A suffix to its file name.
109 void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
112 * Dump a extended block graph with schedule edges.
113 * @param irg The graph.
114 * @param suffix A suffix to its file name.
116 void dump_ir_extblock_graph_sched(ir_graph *irg, const char *suffix);
119 * Dumps a graph and numbers all dumps.
120 * @param irg The graph
121 * @param suffix A suffix to its file name.
122 * @param dumper The dump function
124 void be_dump(ir_graph *irg, const char *suffix, void (*dumper)(ir_graph *, const char *));
127 * Returns the number of reachable nodes in an irg.
128 * @param irg The irg.
129 * @return The number of reachable nodes.
131 unsigned get_num_reachable_nodes(ir_graph *irg);
134 * Sets all node inputs to BAD node.
135 * @param irn The node to be killed.
137 void be_kill_node(ir_node *irn);
140 * Search for an irn in @p accept.
141 * The search is started at @p start_point_exclusive and continues upwards the dom-tree
142 * @return The first node out of accept if found. Else NULL is returned.
144 ir_node *dom_up_search(pset *accept, ir_node *start_point_exclusive);
147 * Gets the Proj with number pn from irn.
149 ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
152 * Opens a file named base.ext with the mode mode.
154 FILE *be_ffopen(const char *base, const char *ext, const char *mode);
156 #endif /* FIRM_BE_BEUTIL_H */