added edge verification routines
[libfirm] / ir / ir / irgmod.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irgmod.h
4  * Purpose:     Support for ir graph modification.
5  * Author:      Martin Trapp, Christian Schaefer
6  * Modified by: Goetz Lindenmaier
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14  *
15  * @file irgmod.h
16  *
17  * ir graph modification.
18  *
19  * @author Martin Trapp, Christian Schaefer
20  */
21 #ifndef _FIRM_IR_IRGMOD_H_
22 #define _FIRM_IR_IRGMOD_H_
23
24 #include "firm_types.h"
25
26 /** Exchanges two nodes by conserving edges leaving old (i.e.,
27    pointers pointing to old).  Turns the old node into an Id. */
28 void exchange (ir_node *old, ir_node *nw);
29
30 /** Turns a node into a "useless" Tuple.
31  *
32  *  Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
33  *  from several inputs.  The predecessors of the tuple have to be
34  *  set by hand.  The block predecessor automatically remains the same.
35  *  This is useful if a node returning a tuple is removed, but the Projs
36  *  extracting values from the tuple are not available.
37  *
38  *  @param node The node to be turned into a tuple.
39  *  @param arity The number of values formed into a Tuple.
40  */
41 void turn_into_tuple (ir_node *node, int arity);
42
43 /** Walks over the passed ir graph and collects all Phi nodes as a
44   * list built with the link field in their corresponding block.
45   * Further it collects all Proj nodes in a list of the node producing
46   * the tuple. In case of nested tuples the Projs are collected in the
47   * node producing the outermost Tuple.
48   * All other link fields are cleared afterwards.
49   */
50 void collect_phiprojs(ir_graph *irg);
51
52 /** Parts a block into two.  This is useful to insert other blocks within a
53  *  given block.
54  *
55  * Adds a new block (new_block) in the control flow before the block
56  * (old_block) of node.  Moves node and its predecessors from old_block to
57  * new_block.  Moves all Projs that depend on moved nodes and are in old_block
58  * to new_block. Moves all Phi nodes from old_block to new_block.  To achieve
59  * this the routine assumes that all Phi nodes are in a list (using the link
60  * field) in the link field of old_block.  Further it assumes that all Proj nodes
61  * are accessible by the link field of the nodes producing the Tuple. This
62  * can be established by collect_phiprojs().  part_block conserves this property.
63  * Adds a Jmp node to new_block that jumps to old_block.
64  * Assumes that node is contained in current_ir_graph.  Sets current_block in
65  * this ir_graph to new_block.
66  *
67  * @param node   The node were to break the block
68  */
69 void part_block(ir_node *node);
70
71 #endif /* ifndef _FIRM_IR_IRGMOD_H_ */