merge kaps
[libfirm] / include / libfirm / cdep.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   control dependence analysis
23  * @author  Christoph Mallon
24  * @version $Id$
25  */
26 #ifndef FIRM_ANA_CDEP_H
27 #define FIRM_ANA_CDEP_H
28
29 #include "firm_types.h"
30 #include "begin.h"
31
32 /**
33  * An entry in the control dependence list.
34  */
35 struct ir_cdep {
36         ir_node *node;  /**< A node on which the current block is control dependent on. */
37         ir_cdep    *next;  /**< Link to the next one if any. */
38 };
39
40 /** Compute the control dependence graph for a graph. */
41 FIRM_API void compute_cdep(ir_graph *irg);
42
43 /** Free the control dependence info. */
44 FIRM_API void free_cdep(ir_graph *irg);
45
46 /**
47  * Return a list of all control dependences of a block.
48  */
49 FIRM_API ir_cdep *find_cdep(const ir_node *block);
50
51 /**
52  * Replace the control dependence info of old by the info of nw.
53  */
54 FIRM_API void exchange_cdep(ir_node *old, const ir_node *nw);
55
56 /**
57  * Check whether dependee is (directly) control dependent on candidate.
58  *
59  * @param dependee   the (possible) dependent block
60  * @param candidate  the (possible) block on which dependee is dependent
61  */
62 FIRM_API int is_cdep_on(const ir_node *dependee, const ir_node *candidate);
63
64 /**
65  * Check whether dependee is (possible iterated) control dependent on candidate.
66  *
67  * @param dependee   the (possible) dependent block
68  * @param candidate  the (possible) block on which dependee is dependent
69  */
70 FIRM_API int is_iterated_cdep_on(ir_node *dependee, ir_node *candidate);
71
72 /**
73  * If block is control dependent on exactly one node, return this node, else NULL.
74  *
75  * @param block  the block to check
76  */
77 FIRM_API ir_node *get_unique_cdep(const ir_node *block);
78
79 /**
80  * Check if the given block is control dependent of more than one node.
81  *
82  * @param block   the block to check
83  */
84 FIRM_API int has_multiple_cdep(const ir_node *block);
85
86 #include "end.h"
87
88 #endif