blob: 741e78107f84639c697238ab863eaddf60e985e0 [file] [log] [blame]
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +00001//== CallGraph.cpp - Call graph building ------------------------*- C++ -*--==//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defined the CallGraph and CGBuilder classes.
11//
12//===----------------------------------------------------------------------===//
13
Daniel Dunbar8fd57fe2009-12-03 07:20:04 +000014#include "clang/Index/CallGraph.h"
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000015
16#include "clang/AST/ASTContext.h"
17#include "clang/AST/StmtVisitor.h"
18
Zhongxing Xu16a705f2009-07-23 09:04:23 +000019#include "llvm/Support/GraphWriter.h"
20
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000021using namespace clang;
22using namespace idx;
23
24namespace {
25class CGBuilder : public StmtVisitor<CGBuilder> {
26
27 CallGraph &G;
28 FunctionDecl *FD;
29
Argyrios Kyrtzidisf7cf15c2009-07-21 00:07:06 +000030 Entity CallerEnt;
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000031
32 CallGraphNode *CallerNode;
33
34public:
Argyrios Kyrtzidisf7cf15c2009-07-21 00:07:06 +000035 CGBuilder(CallGraph &g, FunctionDecl *fd, Entity E, CallGraphNode *N)
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000036 : G(g), FD(fd), CallerEnt(E), CallerNode(N) {}
37
Zhongxing Xu93cbae32009-07-18 08:49:07 +000038 void VisitStmt(Stmt *S) { VisitChildren(S); }
Zhongxing Xu24ff0302009-07-17 05:49:16 +000039
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000040 void VisitCallExpr(CallExpr *CE);
41
42 void VisitChildren(Stmt *S) {
John McCall7502c1d2011-02-13 04:07:26 +000043 for (Stmt::child_range I = S->children(); I; ++I)
Mike Stump1eb44332009-09-09 15:08:12 +000044 if (*I)
45 static_cast<CGBuilder*>(this)->Visit(*I);
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000046 }
47};
48}
49
50void CGBuilder::VisitCallExpr(CallExpr *CE) {
Zhongxing Xua0042542009-07-17 07:29:51 +000051 if (FunctionDecl *CalleeDecl = CE->getDirectCallee()) {
Argyrios Kyrtzidisf7cf15c2009-07-21 00:07:06 +000052 Entity Ent = Entity::get(CalleeDecl, G.getProgram());
Zhongxing Xua0042542009-07-17 07:29:51 +000053 CallGraphNode *CalleeNode = G.getOrInsertFunction(Ent);
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +000054 CallerNode->addCallee(ASTLocation(FD, CE), CalleeNode);
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000055 }
56}
57
Zhongxing Xu6d956df2010-07-02 06:39:46 +000058CallGraph::CallGraph(Program &P) : Prog(P), Root(0) {
Zhongxing Xu56a5d802009-07-23 13:39:38 +000059 ExternalCallingNode = getOrInsertFunction(Entity());
60}
61
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000062CallGraph::~CallGraph() {
63 if (!FunctionMap.empty()) {
64 for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
65 I != E; ++I)
66 delete I->second;
67 FunctionMap.clear();
68 }
69}
70
Zhongxing Xuf20288c2009-10-28 12:23:03 +000071void CallGraph::addTU(ASTContext& Ctx) {
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000072 DeclContext *DC = Ctx.getTranslationUnitDecl();
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000073 for (DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
74 I != E; ++I) {
75
76 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(*I)) {
Sean Hunt10620eb2011-05-06 20:44:56 +000077 if (FD->doesThisDeclarationHaveABody()) {
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000078 // Set caller's ASTContext.
Argyrios Kyrtzidisf7cf15c2009-07-21 00:07:06 +000079 Entity Ent = Entity::get(FD, Prog);
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000080 CallGraphNode *Node = getOrInsertFunction(Ent);
81 CallerCtx[Node] = &Ctx;
Zhongxing Xu56a5d802009-07-23 13:39:38 +000082
83 // If this function has external linkage, anything could call it.
84 if (FD->isGlobal())
85 ExternalCallingNode->addCallee(idx::ASTLocation(), Node);
86
87 // Set root node to 'main' function.
88 if (FD->getNameAsString() == "main")
89 Root = Node;
Mike Stump1eb44332009-09-09 15:08:12 +000090
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000091 CGBuilder builder(*this, FD, Ent, Node);
92 builder.Visit(FD->getBody());
93 }
94 }
95 }
96}
97
Argyrios Kyrtzidisf7cf15c2009-07-21 00:07:06 +000098CallGraphNode *CallGraph::getOrInsertFunction(Entity F) {
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +000099 CallGraphNode *&Node = FunctionMap[F];
100 if (Node)
101 return Node;
102
103 return Node = new CallGraphNode(F);
104}
105
Zhongxing Xue3e643f2009-07-24 03:41:11 +0000106Decl *CallGraph::getDecl(CallGraphNode *Node) {
107 // Get the function's context.
108 ASTContext *Ctx = CallerCtx[Node];
109
110 return Node->getDecl(*Ctx);
111}
112
Chris Lattner5f9e2722011-07-23 10:55:15 +0000113void CallGraph::print(raw_ostream &os) {
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +0000114 for (iterator I = begin(), E = end(); I != E; ++I) {
Zhongxing Xu24ff0302009-07-17 05:49:16 +0000115 if (I->second->hasCallee()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000116 os << "function: " << I->first.getPrintableName()
Zhongxing Xu56aac3f2009-07-17 07:49:44 +0000117 << " calls:\n";
Mike Stump1eb44332009-09-09 15:08:12 +0000118 for (CallGraphNode::iterator CI = I->second->begin(),
Zhongxing Xu24ff0302009-07-17 05:49:16 +0000119 CE = I->second->end(); CI != CE; ++CI) {
Benjamin Kramerd02e2322009-11-14 12:08:24 +0000120 os << " " << CI->second->getName();
Zhongxing Xu24ff0302009-07-17 05:49:16 +0000121 }
122 os << '\n';
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +0000123 }
Zhongxing Xu6bd8fb52009-07-16 00:54:12 +0000124 }
125}
126
127void CallGraph::dump() {
128 print(llvm::errs());
129}
Zhongxing Xu16a705f2009-07-23 09:04:23 +0000130
131void CallGraph::ViewCallGraph() const {
132 llvm::ViewGraph(*this, "CallGraph");
133}
134
135namespace llvm {
136
Mike Stump1eb44332009-09-09 15:08:12 +0000137template <>
Zhongxing Xu16a705f2009-07-23 09:04:23 +0000138struct DOTGraphTraits<CallGraph> : public DefaultDOTGraphTraits {
139
Tobias Grosser006b0eb2009-11-30 14:16:05 +0000140 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
141
Mike Stump1eb44332009-09-09 15:08:12 +0000142 static std::string getNodeLabel(const CallGraphNode *Node,
Tobias Grosser006b0eb2009-11-30 14:16:05 +0000143 const CallGraph &CG) {
Zhongxing Xu16a705f2009-07-23 09:04:23 +0000144 return Node->getName();
Mike Stump1eb44332009-09-09 15:08:12 +0000145
Zhongxing Xu16a705f2009-07-23 09:04:23 +0000146 }
147
148};
149
150}