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