Merge ARM jump table parsing and instruction semantics into master
[dyninst.git] / parseAPI / src / IndirectAnalyzer.C
1 #include "dyntypes.h"
2 #include "IndirectAnalyzer.h"
3 #include "BoundFactCalculator.h"
4 #include "JumpTablePred.h"
5 #include "IA_IAPI.h"
6 #include "debug_parse.h"
7
8 #include "CodeObject.h"
9 #include "Graph.h"
10
11 #include "Instruction.h"
12 #include "InstructionDecoder.h"
13 #include "Register.h"
14 #include "SymEval.h"
15 using namespace Dyninst::ParseAPI;
16 using namespace Dyninst::InstructionAPI;
17
18
19 bool IndirectControlFlowAnalyzer::NewJumpTableAnalysis(std::vector<std::pair< Address, Dyninst::ParseAPI::EdgeTypeEnum > >& outEdges) {
20 //    if (block->last() == 0xfa10) dyn_debug_parsing = 1; else dyn_debug_parsing = 0; 
21
22     parsing_printf("Apply indirect control flow analysis at %lx\n", block->last());
23     parsing_printf("Looking for thunk\n");
24
25 //  Find all blocks that reach the block containing the indirect jump
26 //  This is a prerequisit for finding thunks
27     GetAllReachableBlock();
28 //  Now we try to find all thunks in this function.
29 //  We pass in the slice because we may need to add new ndoes.
30     FindAllThunks();
31 //  Calculates all blocks that can reach
32 //  and be reachable from thunk blocks
33     ReachFact rf(thunks);
34  
35     const unsigned char * buf = (const unsigned char*) block->obj()->cs()->getPtrToInstruction(block->last());
36     InstructionDecoder dec(buf, InstructionDecoder::maxInstructionLength, block->obj()->cs()->getArch());
37     Instruction::Ptr insn = dec.decode();
38     AssignmentConverter ac(true, false);
39     vector<Assignment::Ptr> assignments;
40     ac.convert(insn, block->last(), func, block, assignments);
41     Slicer s(assignments[0], block, func, false, false);
42
43     std::vector<std::pair< Address, Dyninst::ParseAPI::EdgeTypeEnum > > jumpTableOutEdges;
44
45     JumpTablePred jtp(func, block, rf, thunks, jumpTableOutEdges);
46     jtp.setSearchForControlFlowDep(true);
47     GraphPtr slice = s.backwardSlice(jtp);
48     // After the slicing is done, we do one last check to 
49     // see if we can resolve the indirect jump by assuming 
50     // one byte read is in bound [0,255]
51     if (jumpTableOutEdges.empty() && jtp.jumpTableFormat && block->obj()->cs()->getArch() != Arch_aarch64) {
52         GraphPtr g = jtp.BuildAnalysisGraph(s.visitedEdges);
53         
54         BoundFactsCalculator bfc(func, g, func->entry() == block, rf, thunks, true, jtp.expandCache);
55         bfc.CalculateBoundedFacts();
56         
57         BoundValue target;
58         bool ijt = jtp.IsJumpTable(g, bfc, target);
59         if (ijt) jtp.FillInOutEdges(target, jumpTableOutEdges);
60     }
61    // fprintf(stderr, "indirect jump at %lx with %d assignments and %d edges\n", block->last(), jtp.currentAssigns.size(), jumpTableOutEdges.size()); 
62
63     outEdges.insert(outEdges.end(), jumpTableOutEdges.begin(), jumpTableOutEdges.end());
64     return !jumpTableOutEdges.empty();
65 }                                                      
66
67
68
69
70 // Find all blocks that reach the block containing the indirect jump
71 void IndirectControlFlowAnalyzer::GetAllReachableBlock() {
72     reachable.clear();
73     queue<Block*> q;
74     q.push(block);
75     while (!q.empty()) {
76         ParseAPI::Block *cur = q.front();
77         q.pop();
78         if (reachable.find(cur) != reachable.end()) continue;
79         reachable.insert(cur);
80         for (auto eit = cur->sources().begin(); eit != cur->sources().end(); ++eit)
81             if ((*eit)->intraproc()) 
82                 q.push((*eit)->src());
83     }
84
85 }
86
87
88 static Address ThunkAdjustment(Address afterThunk, MachRegister reg, ParseAPI::Block *b) {
89     // After the call to thunk, there is usually
90     // an add insturction like ADD ebx, OFFSET to adjust
91     // the value coming out of thunk.
92    
93     const unsigned char* buf = (const unsigned char*) (b->obj()->cs()->getPtrToInstruction(afterThunk));
94     InstructionDecoder dec(buf, b->end() - b->start(), b->obj()->cs()->getArch());
95     Instruction::Ptr nextInsn = dec.decode();
96     // It has to be an add
97     if (nextInsn->getOperation().getID() != e_add) return 0;
98     vector<Operand> operands;
99     nextInsn->getOperands(operands);
100     RegisterAST::Ptr regAST = boost::dynamic_pointer_cast<RegisterAST>(operands[0].getValue());
101     // The first operand should be a register
102     if (regAST == 0) return 0;
103     if (regAST->getID() != reg) return 0;
104     Result res = operands[1].getValue()->eval();
105     // A not defined result means that
106     // the second operand is not an immediate
107     if (!res.defined) return 0;
108     return res.convert<Address>();
109 }
110
111 void IndirectControlFlowAnalyzer::FindAllThunks() {
112     // Enumuerate every block to find thunk
113     for (auto bit = reachable.begin(); bit != reachable.end(); ++bit) {
114         // We intentional treat a getting PC call as a special case that does not
115         // end a basic block. So, we need to check every instruction to find all thunks
116         ParseAPI::Block *b = *bit;
117         const unsigned char* buf =
118             (const unsigned char*)(b->obj()->cs()->getPtrToInstruction(b->start()));
119         if( buf == NULL ) {
120             parsing_printf("%s[%d]: failed to get pointer to instruction by offset\n",FILE__, __LINE__);
121             return;
122         }
123         parsing_printf("Looking for thunk in block [%lx,%lx).", b->start(), b->end());
124         InstructionDecoder dec(buf, b->end() - b->start(), b->obj()->cs()->getArch());
125         InsnAdapter::IA_IAPI block(dec, b->start(), b->obj() , b->region(), b->obj()->cs(), b);
126         while (block.getAddr() < b->end()) {
127             if (block.getInstruction()->getCategory() == c_CallInsn && block.isThunk()) {
128                 bool valid;
129                 Address addr;
130                 boost::tie(valid, addr) = block.getCFT();
131                 const unsigned char *target = (const unsigned char *) b->obj()->cs()->getPtrToInstruction(addr);
132                 InstructionDecoder targetChecker(target, InstructionDecoder::maxInstructionLength, b->obj()->cs()->getArch());
133                 Instruction::Ptr thunkFirst = targetChecker.decode();
134                 set<RegisterAST::Ptr> thunkTargetRegs;
135                 thunkFirst->getWriteSet(thunkTargetRegs);
136                 
137                 for (auto curReg = thunkTargetRegs.begin(); curReg != thunkTargetRegs.end(); ++curReg) {
138                     ThunkInfo t;
139                     t.reg = (*curReg)->getID();
140                     t.value = block.getAddr() + block.getInstruction()->size();
141                     t.value += ThunkAdjustment(t.value, t.reg, b);
142                     t.block = b;
143                     thunks.insert(make_pair(block.getAddr(), t));
144                     parsing_printf("\tfind thunk at %lx, storing value %lx to %s\n", block.getAddr(), t.value , t.reg.name().c_str());
145                 }
146             }
147             block.advance();
148         }
149     }
150 }
151
152