Update copyright to LGPL on all files
[dyninst.git] / depGraphAPI / src / analyzeXPDG.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 INTRAFUNCTIONXPDGCREATOR_H_
33 #define INTRAFUNCTIONXPDGCREATOR_H_
34
35 #include <map>
36 #include "Node.h"
37 #include "xPDG.h"
38
39 class BPatch_function;
40
41 using namespace std;
42
43 namespace Dyninst {
44 namespace DepGraphAPI {
45
46 /**
47  * The tool that creates the Extended Program Dependence Graph (xPDG) associated with a given 
48  * function (currently BPatch_function). It creates a Program Dependency Graph (PDG)
49  * and a Flow Dependency Graph (FDG) using a PDGAnalyzer and
50  * an FDGAnalyzer. These graphs are merged to create an xPDG.
51  */
52 class xPDGAnalyzer {
53     typedef BPatch_function Function;
54
55 public:
56     typedef BPatch_basicBlock Block;
57     typedef Node::Ptr NodePtr;
58     typedef map<Node*, NodePtr> NodeMap;
59
60 private:
61     // Extended Program Dependence Graph.
62     xPDG::Ptr xpdg;
63
64     // Function  to be analyzed.
65     Function *func_;
66
67     // Gets the PDG for this function and copies it into xPDG.
68     void mergeWithPDG();
69     
70     // Gets the FDG for this function, converts it into sub-instruction level, and merges with the xPDG.
71     void mergeWithFDG();
72
73 public:
74     // Creates an xPDGAnalyzer object that will be used to create an xPDG for the given function.
75     xPDGAnalyzer(Function *f);
76
77     // Analyze the function fed to the constructor and return its Extended Program Dependence Graph.
78     xPDG::Ptr analyze();
79 };
80
81 };
82 };
83
84 #endif /* INTRAFUNCTIONXPDGCREATOR_H_ */