Update copyright to LGPL on all files
[dyninst.git] / depGraphAPI / src / analyzePDG.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 #ifndef INTRAFUNCTIONPDGCREATOR_H_
33 #define INTRAFUNCTIONPDGCREATOR_H_
34
35 #include <map>
36 #include "Graph.h"
37 #include "Node.h"
38 #include "PDG.h"
39
40 class BPatch_function;
41
42 namespace Dyninst {
43 namespace DepGraphAPI {
44
45 // The tool that creates the Program Dependence Graph (PDG) associated with a given 
46 // function (currently BPatch_function). It creates a Data Dependency Graph (DDG)
47 // and a Control Dependency Graph (CDG). These graphs are merged to create an PDG. 
48 class PDGAnalyzer {
49     friend class xPDGAnalyzer;
50
51 private:
52     typedef BPatch_function Function;
53     typedef BPatch_basicBlock Block;
54     typedef std::set<Block *> BlockSet;
55 public:
56     typedef Node::Ptr NodePtr;
57     typedef std::map<Node*, NodePtr> NodeMap;
58
59 private:
60     // Program Dependence Graph.
61     PDG::Ptr pdg;
62     
63     // Function to be analyzed.
64     Function *func_;
65
66     // Gets the DDG for this function and copies it into PDG.
67     void mergeWithDDG();
68
69     // Gets the CDG for this function, converts it into sub-instruction level, and merges with the PDG.
70     void mergeWithCDG();
71
72 protected:
73     
74     // Creates edges from given source to all nodes between targetsBegin and targetsEnd
75     static void createEdges(Graph::Ptr graph, Node::Ptr source,
76             NodeIterator targetsBegin, NodeIterator targetsEnd);
77 public:
78     // Creates a PDGAnalyzer object that will be used to create a PDG for the given function.
79     PDGAnalyzer(Function *f);
80
81     // Analyze the function fed to the constructor and return its Program Dependence Graph. 
82     PDG::Ptr analyze();
83 };
84
85 };
86 };
87
88 #endif /* INTRAFUNCTIONPDGCREATOR_H_ */