BSF and BSR instructions can produce bounds for jump tables
[dyninst.git] / parseAPI / src / JumpTablePred.C
1 #include "dyntypes.h"
2 #include "Node.h"
3 #include "Graph.h"
4
5 #include "debug_parse.h"
6 #include "CodeObject.h"
7 #include "JumpTablePred.h"
8 #include "IndirectASTVisitor.h"
9
10 #include "Instruction.h"
11 #include "InstructionDecoder.h"
12
13 #include "AbslocInterface.h"
14 #include "SymEval.h"
15
16 using namespace Dyninst;
17 using namespace Dyninst::DataflowAPI;
18 using namespace Dyninst::ParseAPI;
19 using namespace Dyninst::InstructionAPI;
20 #define SIGNEX_64_32 0xffffffff00000000LL
21 #define SIGNEX_64_16 0xffffffffffff0000LL
22 #define SIGNEX_64_8  0xffffffffffffff00LL
23 #define SIGNEX_32_16 0xffff0000
24 #define SIGNEX_32_8 0xffffff00
25
26 // Assume the table contain less than this many entries.
27 #define MAX_TABLE_ENTRY 1000000
28
29 static void BuildEdgesAux(SliceNode::Ptr srcNode,
30                           ParseAPI::Block* curBlock,
31                           map<ParseAPI::Block*, map<AssignmentPtr, SliceNode::Ptr> > &targetMap,
32                           GraphPtr newG,
33                           set<ParseAPI::Block*> &visit,
34                           EdgeTypeEnum t,
35                           set<ParseAPI::Edge*> allowedEdges) {                   
36     if (targetMap.find(curBlock) != targetMap.end()) {
37         // This block contains at least one silce node 
38         // that is reachable from the source DFS node
39         map<AssignmentPtr, SliceNode::Ptr> &candNodes = targetMap[curBlock];
40         Address addr = 0;
41         for (auto cit = candNodes.begin(); cit != candNodes.end(); ++cit)
42             // The node has to be either in a different block from the source node
43             // or in the same block but has a larger address to be considered 
44             // reachable from the source node
45             if (cit->first->addr() > srcNode->addr() || curBlock != srcNode->block())
46                 if (addr == 0 || addr > cit->first->addr()) {
47                     addr = cit->first->addr();
48                 }
49         if (addr != 0) {
50             // There may be several assignments locating 
51             // at the same address. Need to connecting all.
52             if (t == _edgetype_end_) t = FALLTHROUGH;
53             for (auto cit = candNodes.begin(); cit != candNodes.end(); ++cit)
54                 if (cit->first->addr() > srcNode->addr() || curBlock != srcNode->block())
55                     if (addr == cit->first->addr()) {
56                         newG->insertPair(srcNode, cit->second, TypedSliceEdge::create(srcNode, cit->second, t));
57                     }
58             return;
59         }
60     }
61
62     if (visit.find(curBlock) != visit.end()) return;
63     visit.insert(curBlock);
64     for (auto eit = curBlock->targets().begin(); eit != curBlock->targets().end(); ++eit)
65         // Xiaozhu:
66         // Our current slicing code ignores tail calls 
67         // (the slice code only checks if an edge type is CALL or not)
68         // so, I should be consistent here.
69         // If the slice code considers tail calls, need to change
70         // the predicate to (*eit)->interproc()
71         if ((*eit)->type() != CALL && (*eit)->type() != RET && allowedEdges.find(*eit) != allowedEdges.end()) {
72             EdgeTypeEnum newT = t; 
73             if (t == _edgetype_end_) {
74                 if ((*eit)->type() == COND_TAKEN || (*eit)->type() == COND_NOT_TAKEN) 
75                     newT = (*eit)->type();
76                 else 
77                     newT = FALLTHROUGH;
78             } 
79             BuildEdgesAux(srcNode, (*eit)->trg(), targetMap, newG, visit, newT, allowedEdges);     
80         }
81 }                         
82
83
84 static void BuildEdges(SliceNode::Ptr curNode,
85                        map<ParseAPI::Block*, map<AssignmentPtr, SliceNode::Ptr> > &targetMap,
86                        GraphPtr newG,
87                        set<ParseAPI::Edge*> &allowedEdges) {
88     set<ParseAPI::Block*> visit;                     
89     BuildEdgesAux(curNode, curNode->block(), targetMap, newG, visit, _edgetype_end_, allowedEdges);
90 }                      
91
92 static bool AssignIsZF(Assignment::Ptr a) {
93     return a->out().absloc().type() == Absloc::Register &&
94            (a->out().absloc().reg() == x86::zf || a->out().absloc().reg() == x86_64::zf);
95 }
96
97 static bool IsPushAndChangeSP(Assignment::Ptr a) {
98     entryID id = a->insn()->getOperation().getID();
99     if (id != e_push) return false;
100     Absloc aloc = a->out().absloc();
101     if (aloc.type() == Absloc::Register && aloc.reg().isStackPointer()) return true;
102     return false;;
103
104 }
105
106 static int AdjustGraphEntryAndExit(GraphPtr gp) {
107     int nodeCount = 0;
108     NodeIterator gbegin, gend;
109     gp->allNodes(gbegin, gend);
110     for (; gbegin != gend; ++gbegin) {
111         ++nodeCount;
112         Node::Ptr ptr = *gbegin;
113         if (!ptr->hasInEdges()) gp->insertEntryNode(ptr);
114         if (!ptr->hasOutEdges()) gp->insertExitNode(ptr);
115     }
116     return nodeCount;
117 }
118
119
120 GraphPtr JumpTablePred::BuildAnalysisGraph(set<ParseAPI::Edge*> &visitedEdges) {
121     GraphPtr newG = Graph::createGraph();
122     
123     NodeIterator gbegin, gend;
124     
125     // Create a map to help find whether we have reached a node
126     map<ParseAPI::Block*, map<AssignmentPtr, SliceNode::Ptr> > targetMap;
127
128     // Assignments that are at these addresses have flag assignment colocated
129     set<Address> shouldSkip;
130     for (auto ait = currentAssigns.begin(); ait != currentAssigns.end(); ++ait) {
131         if (AssignIsZF(*ait))
132             shouldSkip.insert((*ait)->addr());
133     }
134     for (auto ait = currentAssigns.begin(); ait != currentAssigns.end(); ++ait) {
135         Assignment::Ptr a = *ait;
136         if (   (AssignIsZF(a) || shouldSkip.find(a->addr()) == shouldSkip.end()) 
137             && !IsPushAndChangeSP(a)
138             && (!a->insn()->writesMemory() || MatchReadAST(a))) {
139             SliceNode::Ptr newNode = SliceNode::create(a, a->block(), a->func());
140             targetMap[a->block()][a] = newNode;
141             newG->addNode(newNode);
142         }
143     }
144
145     // Start from each node to do DFS and build edges
146     newG->allNodes(gbegin, gend);
147     for (; gbegin != gend; ++gbegin) {
148         SliceNode::Ptr node = boost::static_pointer_cast<SliceNode>(*gbegin);
149         BuildEdges(node, targetMap, newG, visitedEdges);
150     }
151
152     // Build a virtual exit node
153     SliceNode::Ptr virtualExit = SliceNode::create(Assignment::Ptr(), NULL, NULL);
154     newG->addNode(virtualExit);
155     newG->allNodes(gbegin, gend);
156     for (; gbegin != gend; ++gbegin) {
157         SliceNode::Ptr cur = boost::static_pointer_cast<SliceNode>(*gbegin);
158         if (!cur->hasOutEdges() && cur != virtualExit) {
159             newG->insertPair(cur, virtualExit, TypedSliceEdge::create(cur, virtualExit, FALLTHROUGH));
160         }
161     }
162
163     AdjustGraphEntryAndExit(newG);
164
165
166     return newG;
167
168 }
169
170
171 bool JumpTablePred::endAtPoint(AssignmentPtr ap) {
172 //        if (ap->insn()->writesMemory()) return true;
173         return false;
174 }
175 bool JumpTablePred::addNodeCallback(AssignmentPtr ap, set<ParseAPI::Edge*> &visitedEdges) {
176     if (currentAssigns.find(ap) != currentAssigns.end()) return true;
177     if (currentAssigns.size() > 200) return false; 
178     // For flags, we only analyze zf
179     if (ap->out().absloc().type() == Absloc::Register && ap->out().absloc().reg().regClass() == x86::FLAG &&
180        ap->out().absloc().reg() != x86::zf && ap->out().absloc().reg() != x86_64::zf) {
181         return true;
182     }
183
184     pair<AST::Ptr, bool> expandRet = ExpandAssignment(ap);
185     // If we do not have semantics for this instruction,
186     // we assume it does not influence the calculation of jump targets
187     if (!expandRet.second || expandRet.first == NULL) return true;
188
189
190     fprintf(stderr, "Adding assignment %s in instruction %s at %lx\n", ap->format().c_str(), ap->insn()->format().c_str(), ap->addr());
191     currentAssigns.insert(ap);
192
193     // If this assignment writes memory,
194     // we only want to analyze it when it writes to 
195     // an AST we have seen before and potentially
196     // can used for aliasing
197     if (ap->insn()->writesMemory()) {
198         if (!MatchReadAST(ap)) return true;
199     }
200
201     // If this assignment reads memory,
202     // we record the AST of the read so
203     // that in the future we can match a
204     // corresponding write to identify aliasing
205     if (ap->insn()->readsMemory() && expandRet.first->getID() == AST::V_RoseAST) {
206         RoseAST::Ptr roseAST = boost::static_pointer_cast<RoseAST>(expandRet.first);
207         if (roseAST->val().op == ROSEOperation::derefOp) {
208             readAST.push_back(expandRet.first);
209         }
210     }
211
212     // We create the CFG based on the found nodes
213     GraphPtr g = BuildAnalysisGraph(visitedEdges);
214
215     BoundFactsCalculator bfc(func, g, func->entry() == block, rf, thunks, block->last(), expandCache);
216     bfc.CalculateBoundedFacts();
217
218     BoundValue target;
219     bool ijt = IsJumpTable(g, bfc, target);
220     if (ijt) {
221         bool ret = !FillInOutEdges(target, outEdges);
222         fprintf(stderr, "Return %s\n", ret ? "true" : "false");
223 //      if (dyn_debug_parsing) exit(0);
224         return ret;
225     } else {
226         fprintf(stderr, "Return true\n");
227 //      if (dyn_debug_parsing) exit(0);
228
229         return true;
230     }   
231
232
233
234 }
235 bool JumpTablePred::FillInOutEdges(BoundValue &target, 
236                                                  vector<pair< Address, Dyninst::ParseAPI::EdgeTypeEnum > >& outEdges) {
237     outEdges.clear();
238     Address tableBase = target.interval.low;
239     Address tableLastEntry = target.interval.high;
240     Architecture arch = block->obj()->cs()->getArch();
241     if (arch == Arch_x86) {
242         tableBase &= 0xffffffff;
243         tableLastEntry &= 0xffffffff;
244     }
245
246 #if defined(os_windows)
247     tableBase -= block->obj()->cs()->loadAddress();
248     tableLastEntry -= block->obj()->cs()->loadAddress();
249 #endif
250
251     parsing_printf("The final target bound fact:\n");
252     target.Print();
253     if (!block->obj()->cs()->isValidAddress(tableBase)) {
254         parsing_printf("\ttableBase 0x%lx invalid, returning false\n", tableBase);
255         return false;
256     }
257
258     for (Address tableEntry = tableBase; tableEntry <= tableLastEntry; tableEntry += target.interval.stride) {
259         if (!block->obj()->cs()->isValidAddress(tableEntry)) continue;
260         Address targetAddress = 0;
261         if (target.tableReadSize > 0) {
262             // Assume the table contents are moved in a sign extended way;
263             switch (target.tableReadSize) {
264                 case 8:
265                     targetAddress = *(const uint64_t *) block->obj()->cs()->getPtrToInstruction(tableEntry);
266                     break;
267                 case 4:
268                     targetAddress = *(const uint32_t *) block->obj()->cs()->getPtrToInstruction(tableEntry);
269                     if ((arch == Arch_x86_64) && (targetAddress & 0x80000000)) {
270                         targetAddress |= SIGNEX_64_32;
271                     }
272                     break;
273                 case 2:
274                     targetAddress = *(const uint16_t *) block->obj()->cs()->getPtrToInstruction(tableEntry);
275                     if ((arch == Arch_x86_64) && (targetAddress & 0x8000)) {
276                         targetAddress |= SIGNEX_64_16;
277                     }
278                     if ((arch == Arch_x86) && (targetAddress & 0x8000)) {
279                         targetAddress |= SIGNEX_32_16;
280                     }
281
282                     break;
283                 case 1:
284                     targetAddress = *(const uint8_t *) block->obj()->cs()->getPtrToInstruction(tableEntry);
285                     if ((arch == Arch_x86_64) && (targetAddress & 0x80)) {
286                         targetAddress |= SIGNEX_64_8;
287                     }
288                     if ((arch == Arch_x86) && (targetAddress & 0x80)) {
289                         targetAddress |= SIGNEX_32_8;
290                     }
291
292                     break;
293
294                 default:
295                     parsing_printf("Invalid memory read size %d\n", target.tableReadSize);
296                     return false;
297             }
298             if (targetAddress != 0) {
299                 if (target.isSubReadContent) 
300                     targetAddress = target.targetBase - targetAddress;
301                 else 
302                     targetAddress += target.targetBase; 
303
304             }
305 #if defined(os_windows)
306             targetAddress -= block->obj()->cs()->loadAddress();
307 #endif
308         } else targetAddress = tableEntry;
309
310         if (block->obj()->cs()->getArch() == Arch_x86) targetAddress &= 0xffffffff;
311         parsing_printf("Jumping to target %lx,", targetAddress);
312         if (block->obj()->cs()->isCode(targetAddress)) {
313             outEdges.push_back(make_pair(targetAddress, INDIRECT));
314             parsing_printf(" is code.\n" );
315         } else {
316             parsing_printf(" not code.\n");
317         }
318         // If the jump target is resolved to be a constant, 
319         if (target.interval.stride == 0) break;
320     }
321     return true;
322 }
323 bool JumpTablePred::IsJumpTable(GraphPtr slice, 
324                                               BoundFactsCalculator &bfc,
325                                               BoundValue &target) {
326     NodeIterator exitBegin, exitEnd, srcBegin, srcEnd;
327     slice->exitNodes(exitBegin, exitEnd);
328     SliceNode::Ptr virtualExit = boost::static_pointer_cast<SliceNode>(*exitBegin);
329     virtualExit->ins(srcBegin, srcEnd);
330     SliceNode::Ptr jumpNode = boost::static_pointer_cast<SliceNode>(*srcBegin);
331     
332     const Absloc &loc = jumpNode->assign()->out().absloc();
333     parsing_printf("Checking final bound fact for %s\n",loc.format().c_str()); 
334     BoundFact *bf = bfc.GetBoundFactOut(virtualExit);
335     BoundValue *tarBoundValue = bf->GetBound(VariableAST::create(Variable(loc)));
336     if (tarBoundValue != NULL) {
337         target = *(tarBoundValue);
338         uint64_t s = target.interval.size();
339         if (s > 0 && s <= MAX_TABLE_ENTRY) return true;
340     }
341     return false;
342 }
343
344 bool JumpTablePred::MatchReadAST(Assignment::Ptr a) {
345     pair<AST::Ptr, bool> expandRet = ExpandAssignment(a);
346     if (!expandRet.second || expandRet.first == NULL) return false;
347     if (a->out().generator() == NULL) return false;
348     AST::Ptr write = SimplifyAnAST(RoseAST::create(ROSEOperation(ROSEOperation::derefOp, a->out().size()), a->out().generator()), a->insn()->size());
349
350     if (write == NULL) return false;
351     for (auto ait = readAST.begin(); ait != readAST.end(); ++ait) 
352         if (*write == **ait) return true;
353     return false;
354 }
355
356 pair<AST::Ptr, bool> JumpTablePred::ExpandAssignment(Assignment::Ptr assign) {
357     if (expandCache.find(assign) != expandCache.end()) {
358         AST::Ptr ast = expandCache[assign];
359 //      if (ast) return make_pair(DeepCopyAnAST(ast), true); else return make_pair(ast, false);
360         if (ast) return make_pair(ast, true); else return make_pair(ast, false);
361
362     } else {
363         pair<AST::Ptr, bool> expandRet = SymEval::expand(assign, false);
364         if (expandRet.second && expandRet.first) {
365 parsing_printf("Original expand: %s\n", expandRet.first->format().c_str());
366
367             AST::Ptr calculation = SimplifyAnAST(expandRet.first, assign->insn()->size());
368             //expandCache[assign] = DeepCopyAnAST(expandRet.first);
369             expandCache[assign] = calculation;
370         } else {
371             expandCache[assign] = AST::Ptr();
372         }
373         return make_pair( expandCache[assign], expandRet.second );
374     }
375 }
376