Add code to find edges from indirect jumps
[dyninst.git] / parseAPI / src / BoundFactCalculator.C
1 #include "IndirectControlFlow.h"
2 #include "IndirectASTVisitor.h"
3 #include "debug_parse.h"
4
5 bool BoundFactsCalculator::CalculateBoundedFacts() {    
6     /* We use a dataflow analysis to calculate what registers are bounded 
7      * at each node. The key points of the dataflow analysis are how
8      * to calculate the meet and how to calculate the transfer function.
9      * 1. The meet should be simply an intersection of all the bounded facts 
10      * along all paths. 
11      * 2. To calculate the transfer function, we first get the symbolic expression
12      * of the instrution for the node. Then depending on the instruction operation
13      * and the meet result, we know what are still bounded. For example, loading 
14      * memory is always unbounded; doing and operation on a register with a constant
15      * makes the register bounded. 
16      */
17     
18
19     defined.clear();
20     queue<Node::Ptr> workingList;
21
22     NodeIterator nbegin, nend;
23     slice->allNodes(nbegin, nend);
24
25     for (; nbegin != nend; ++nbegin) {
26         workingList.push(*nbegin);
27     }
28
29
30     while (!workingList.empty()) {
31         Node::Ptr curNode = workingList.front();
32         workingList.pop();
33
34         BoundFact oldFact = boundFacts[curNode];
35         Meet(curNode);
36         CalcTransferFunction(curNode);
37
38         if (defined.find(curNode) == defined.end() || oldFact != boundFacts[curNode]) {
39             curNode->outs(nbegin, nend);
40             for (; nbegin != nend; ++nbegin)
41                 workingList.push(*nbegin);
42         }
43         defined.insert(curNode);
44     }
45
46     return true;
47 }
48
49
50 void BoundFactsCalculator::ConditionalJumpBound(BoundFact& curFact, Node::Ptr src, Node::Ptr trg) {
51
52     /* This function checks whether any potential table guard is between the two nodes
53      * that we are calculating the meet. Essentially, if there is a conditional jump 
54      * between the two nodes, we know extra bound information.     
55      */   
56
57     ParseAPI::Block *srcBlock;
58     if (src == Node::Ptr()) 
59         srcBlock = func->entry();
60     else {
61         SliceNode::Ptr srcNode = boost::static_pointer_cast<SliceNode>(src);
62         srcBlock = srcNode->block();
63
64     }
65     SliceNode::Ptr trgNode = boost::static_pointer_cast<SliceNode>(trg);                               
66     ParseAPI::Block *trgBlock = trgNode->block();
67
68     for (auto git = guards.begin(); git != guards.end(); ++git) {
69         parsing_printf("Checking guard at %lx\n", git->jmpInsnAddr);
70         if (!git->constantBound) {
71             parsing_printf("\t not a constant bound, skip\n");
72             continue;
73         }           
74
75         ParseAPI::Block *guardBlock = git->block;
76         // Note that the guardBlock and the srcBlock can be the same, 
77         // but since the conditional jump will always be the last instruction
78         // in the block, if they are in the same block, the src can reach the guard
79         if (src != Node::Ptr() && rf.incoming[guardBlock].find(srcBlock) == rf.incoming[guardBlock].end()) {
80             parsing_printf("\t this guard is not between the source block %lx and the target %lx, skip\n", srcBlock->start(), guardBlock->start());
81             continue;
82         }           
83         bool pred_taken = rf.branch_taken[guardBlock].find(trgBlock) != rf.branch_taken[guardBlock].end();
84         bool pred_ft = rf.branch_ft[guardBlock].find(trgBlock) != rf.branch_ft[guardBlock].end();
85         parsing_printf("pred_taken : %d, pred_ft: %d\n", pred_taken, pred_ft);
86         // If both branches reach the trg node, then this conditional jump 
87         // does not bound any variable for the trg node.
88         if (pred_taken ^ pred_ft) {
89             // Here I need to figure out which branch bounds the variable and 
90             // check it is the bounded path that reaches the trg node.
91             AST::Ptr cmpAST;
92             bool boundedOnTakenBranch = git->varSubtrahend ^ git->jumpWhenNoZF;
93             if (   (boundedOnTakenBranch && pred_taken)
94                 // In thic case, we jump when the variable is smaller than the constant.
95                 // So the condition taken path is the path that bounds the value.
96                 || (!boundedOnTakenBranch && pred_ft) ) {
97                 // In thic case, we jump when the variable is larger than the constant.
98                 // So the fallthrough path is the path that bounds the value.
99
100                 if (curFact.cmpBoundFactLive == false || git->cmpBound > curFact.cmpBound) {
101                     curFact.cmpAST = git->cmpAST;
102                     curFact.cmpBound = git->cmpBound;
103                     curFact.cmpBoundFactLive = true;
104                     curFact.cmpUsedRegs = git->usedRegs;
105                 }
106             }
107         }
108     }
109     if (!curFact.cmpBoundFactLive && firstBlock) {
110         // If this is indirect jump is in the first block,
111         // it is possible that it is a jump table for a function 
112         // with variable number of arguments. Then the convention
113         // is that al contains the number of argument.
114         curFact.cmpAST = VariableAST::create(Variable(Absloc(x86_64::rax)));
115         curFact.cmpBound = 8;
116         curFact.cmpUsedRegs.insert(x86_64::rax);
117         curFact.cmpBoundFactLive = true;
118
119
120     }
121 }
122
123 void BoundFactsCalculator::Meet(Node::Ptr curNode) {
124
125     SliceNode::Ptr node = boost::static_pointer_cast<SliceNode>(curNode); 
126     parsing_printf("Calculate Meet for %lx\n", node->addr());
127
128     NodeIterator gbegin, gend;
129     curNode->ins(gbegin, gend);    
130     BoundFact &curFact = boundFacts[curNode];
131     parsing_printf("curFact Fact right after fecting from the map is\n");
132     curFact.Print();
133
134     if (gbegin != gend) {
135         bool first = true;      
136         for (; gbegin != gend; ++gbegin) {
137             parsing_printf("curFact Fact before the change is\n");
138             curFact.Print();
139
140             SliceNode::Ptr meetSliceNode = boost::static_pointer_cast<SliceNode>(*gbegin);          
141             if (defined.find(*gbegin) == defined.end()) {
142                 parsing_printf("\tIncoming node %lx has not been calculated yet\n", meetSliceNode->addr());
143                 continue;
144             }
145             parsing_printf("\tMeet incoming edge from %lx\n", meetSliceNode->addr());
146             BoundFact prevFact = boundFacts[(*gbegin)]; 
147             ConditionalJumpBound(prevFact, *gbegin, curNode);
148             if (first) {
149                 first = false;
150                 curFact = prevFact;
151             } else {
152                 curFact.Intersect(prevFact);
153             }
154             parsing_printf("curFact Fact after the change is\n");
155             curFact.Print();
156
157         }
158     } else {
159         ConditionalJumpBound(curFact, Node::Ptr(), curNode);
160         parsing_printf("Meet no incoming nodes\n");
161         curFact.Print();
162     }
163 }
164
165 void BoundFactsCalculator::CalcTransferFunction(Node::Ptr curNode){
166
167     SliceNode::Ptr node = boost::static_pointer_cast<SliceNode>(curNode);    
168     AbsRegion &ar = node->assign()->out();
169
170     BoundFact &curFact = boundFacts[curNode];
171     parsing_printf("### size of BoundValue is %d\n", sizeof(BoundValue));
172     parsing_printf("Expanding assignment %s in instruction at %lx: %s.\n", node->assign()->format().c_str(), node->addr(), node->assign()->insn()->format().c_str());
173     pair<AST::Ptr, bool> expandRet = SymEval::expand(node->assign(), false);
174
175     if (expandRet.first == NULL) {
176         // If the instruction is outside the set of instrutions we
177         // add instruction semantics. We assume this instruction
178         // kills all bound fact.
179         parsing_printf("\t No semantic support for this instruction. Kill all bound fact\n");
180         return;
181     }
182     parsing_printf("\t AST after expanding (without simplify) %s\n", expandRet.first->format().c_str());
183
184     AST::Ptr calculation = SimplifyAnAST(expandRet.first, node->assign()->insn()->size());
185
186     parsing_printf("\t AST after expanding %s\n", calculation->format().c_str());
187     parsing_printf("Calculating transfer function: Input facts\n");
188     curFact.Print();
189
190     BoundCalcVisitor bcv(curFact);
191     calculation->accept(&bcv);
192
193     if (bcv.IsResultBounded(calculation)) { 
194         parsing_printf("Genenerate bound fact for %s\n", ar.absloc().format().c_str());
195         curFact.GenFact(ar.absloc(), bcv.GetResultBound(calculation));
196     }
197     else {
198         parsing_printf("Kill bound fact for %s\n", ar.absloc().format().c_str());
199         curFact.KillFact(ar.absloc());
200     }
201     parsing_printf("Calculating transfer function: Output facts\n");
202     curFact.Print();
203
204 }                                               
205
206