Update copyright to LGPL on all files
[dyninst.git] / depGraphAPI / src / analyzeCDG.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #if !defined(CDG_ANALYZER_H)
33 #define CDG_ANALYZER_H
34
35 #include <map>
36 #include <set>
37
38 #include "Node.h"
39 #include "CDG.h"
40
41 class BPatch_basicBlock;
42 class BPatch_function;
43
44 namespace Dyninst {
45 namespace DepGraphAPI {
46
47 // The tool that creates the Control Dependence Graph (CDG) associated with a given 
48 // function (currently BPatch_function). It uses Dominator Analysis provided by
49 // Dyninst. The algorithm is borrowed from Ferrante et. al.
50 class CDGAnalyzer {
51 private:
52     typedef BPatch_function Function;
53     // TODO: replace this with ParsingAPI concepts.
54     // Right now we use BPatch_basicBlock since it has
55     // dominator info
56     typedef BPatch_basicBlock Block;
57
58 public:
59     typedef std::set<Block*> BlockSet;
60     typedef Node::Ptr NodePtr;
61     typedef std::map<Block*, NodePtr> NodeMap;
62
63 private:
64     // Temporary structure to hold nodes we've already created
65     NodeMap nodeMap;
66
67     // Control Dependence Graph.
68     CDG::Ptr cdg;
69
70     // Function that will de processed to create CDG. 
71     Function *func_;
72
73     // Create dependencies between blocks.
74     void createDependencies(BlockSet &blocks);
75
76         // Create and return a BlockNode.
77     Node::Ptr makeNode(Block*);
78
79 public:
80     // Constructs a CDGAnalyzer with the given function.
81     CDGAnalyzer(Function *f);
82
83     // Creates and returns the CDG for the associated function. Note that the CDG
84     // that is returned is at basic block-level
85     CDG::Ptr analyze();
86 };
87
88 };
89 };
90 #endif /* CDG_ANALYZER_H */