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 Support for ir graph modification.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
26 #ifndef FIRM_IR_IRGMOD_H
27 #define FIRM_IR_IRGMOD_H
29 #include "firm_types.h"
31 /** Exchanges two nodes by conserving edges leaving old (i.e.,
32 pointers pointing to old). Turns the old node into an Id. */
33 void exchange(ir_node *old, ir_node *nw);
35 /** Turns a node into a "useless" Tuple.
37 * Turns a node into a "useless" Tuple. The Tuple node just forms a tuple
38 * from several inputs. The predecessors of the tuple have to be
39 * set by hand. The block predecessor automatically remains the same.
40 * This is useful if a node returning a tuple is removed, but the Projs
41 * extracting values from the tuple are not available.
43 * @param node The node to be turned into a tuple.
44 * @param arity The number of values formed into a Tuple.
46 void turn_into_tuple(ir_node *node, int arity);
48 /** Walks over the passed ir graph and collects all Phi nodes as a
49 * list built with the link field in their corresponding block.
50 * Further it collects all Proj nodes in a list of the node producing
51 * the tuple. In case of nested tuples the Projs are collected in the
52 * node producing the outermost Tuple.
53 * All other link fields are cleared afterwards.
55 void collect_phiprojs(ir_graph *irg);
57 /** Parts a block into two. This is useful to insert other blocks within a
60 * Adds a new block (new_block) in the control flow before the block
61 * (old_block) of node. Moves node and its predecessors from old_block to
62 * new_block. Moves all Projs that depend on moved nodes and are in old_block
63 * to new_block. Moves all Phi nodes from old_block to new_block. To achieve
64 * this the routine assumes that all Phi nodes are in a list (using the link
65 * field) in the link field of old_block. Further it assumes that all Proj nodes
66 * are accessible by the link field of the nodes producing the Tuple. This
67 * can be established by collect_phiprojs(). part_block conserves this property.
68 * Adds a Jmp node to new_block that jumps to old_block.
69 * Assumes that node is contained in current_ir_graph. Sets current_block in
70 * this ir_graph to new_block.
72 * @param node The node were to break the block
74 void part_block(ir_node *node);
77 * Kill a node by setting its predecessors to Bad and finally
78 * exchange the node by Bad itself.
80 void kill_node(ir_node *node);
82 #endif /* FIRM_IR_IRGMOD_H */