Symbolic expansion now returns an error code if we fail to translate an instruction...
[dyninst.git] / dataflowAPI / src / SymEval.C
1 /*
2  * Copyright (c) 1996-2007 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
30  */
31
32 #include <string>
33 #include <iostream>
34
35 #include "../h/SymEval.h"
36 #include "SymEvalPolicy.h"
37
38 #include "AST.h"
39
40 #include "parseAPI/h/CFG.h"
41
42 #include "../rose/x86InstructionSemantics.h"
43 #include "../rose/powerpcInstructionSemantics.h"
44 #include "../rose/SgAsmInstruction.h"
45 #include "../h/stackanalysis.h"
46 #include "SymEvalVisitors.h"
47
48 #include "RoseInsnFactory.h"
49 #include "SymbolicExpansion.h"
50
51 #include "../h/Absloc.h"
52
53 #include "../h/slicing.h" // SliceNode
54
55 #include "debug_dataflow.h"
56
57 #include "boost/tuple/tuple.hpp"
58
59 using namespace Dyninst;
60 using namespace InstructionAPI;
61 using namespace DataflowAPI;
62
63
64 std::pair<AST::Ptr, bool> SymEval::expand(const Assignment::Ptr &assignment) {
65   // This is a shortcut version for when we only want a
66   // single assignment
67   
68   Result_t res;
69   // Fill it in to mark it as existing
70   res[assignment] = AST::Ptr();
71   std::set<Instruction::Ptr> ignored;
72   bool succ = expand(res, ignored);
73   return std::make_pair(res[assignment], succ);
74 }
75
76 bool SymEval::expand(Result_t &res, 
77                      std::set<Instruction::Ptr> &failedInsns,
78                      bool applyVisitors) {
79   // Symbolic evaluation works off an Instruction
80   // so we have something to hand to ROSE. 
81    failedInsns.clear();
82    for (Result_t::iterator i = res.begin(); i != res.end(); ++i) {
83       if (i->second != AST::Ptr()) {
84          // Must've already filled it in from a previous instruction crack
85          continue;
86       }
87     Assignment::Ptr ptr = i->first;
88     
89     bool success = expandInsn(ptr->insn(),
90                               ptr->addr(),
91                               res);
92     if (!success) failedInsns.insert(ptr->insn());
93    }
94
95    if (applyVisitors) {
96       // Must apply the visitor to each filled in element
97       for (Result_t::iterator i = res.begin(); i != res.end(); ++i) {
98          if (!i->second) continue;
99          AST::Ptr tmp = simplifyStack(i->second, i->first->addr(), i->first->func());
100          BooleanVisitor b;
101          AST::Ptr tmp2 = tmp->accept(&b);
102          i->second = tmp2;
103       }
104    }
105    return (!failedInsns.size());
106 }
107
108 void dfs(Node::Ptr source,
109          std::map<Node::Ptr, int> &state,
110          std::set<Edge::Ptr> &skipEdges) {
111
112    // DFS from the node given by source
113    // If we meet a node twice without having to backtrack first,
114    // insert that incoming edge into skipEdges.
115    //
116    // A node n has state[n] > 0 if it is on the path currently
117    // being explored.
118
119    EdgeIterator b, e;
120    source->outs(b, e);
121
122    //state[source]++;
123    std::map<Node::Ptr, int>::iterator ssit = state.find(source);
124    if(ssit == state.end())
125     boost::tuples::tie(ssit,boost::tuples::ignore) = 
126         state.insert(make_pair(source,1));
127    else
128     (*ssit).second++;
129
130    for (; b != e; ++b) {
131       Edge::Ptr edge = *b;
132       Node::Ptr cur = edge->target();
133
134       std::map<Node::Ptr, int>::iterator sit = state.find(cur);
135       bool done = (sit != state.end());
136
137       if(done && (*sit).second > 0)
138         skipEdges.insert(edge);
139
140       if(!done)
141         dfs(cur, state, skipEdges);
142    }
143
144    //state[source]--;
145    (*ssit).second--;
146 }
147
148 /*
149  * Optimal ordering for visiting the slicing
150  * nodes during expansion; this is possible to do
151  * because we have removed loops
152  */
153 class ExpandOrder {
154  public:
155     ExpandOrder() { }
156     ~ExpandOrder() { }
157
158     // remove an element from the next-lowest queue
159     // and return it and its order
160     pair<SliceNode::Ptr,int> pop_next()
161     {
162         SliceNode::Ptr rn = SliceNode::Ptr();
163         int ro = -1;
164
165         map<int,order_queue>::iterator qit = queues.begin();
166         for( ; qit != queues.end(); ++qit) {
167             order_queue & q = (*qit).second;
168             if(!q.nodes.empty()) {
169                 rn = *q.nodes.begin();
170                 ro = q.order; 
171                 remove(rn);
172                 break;
173             }
174         }
175         return make_pair(rn,ro);
176     }
177
178     // removes a node from the structure
179     // returns true if the node was there
180     bool remove(SliceNode::Ptr n) {
181         map<SliceNode::Ptr, int>::iterator it = order_map.find(n);
182         if(it != order_map.end()) {
183             queues[ (*it).second ].nodes.erase(n);
184             order_map.erase(it);
185             return true;
186         } 
187         return false;
188     }
189
190     // places a node in the structure -- its
191     // order is computed
192     void insert(SliceNode::Ptr n, bool force_done = false) {
193         // compute the order of this node --- the number of its parents
194         // not on the skipedges list and not done
195         EdgeIterator begin, end;
196         n->ins(begin,end);
197         int pcnt = 0;
198         for( ; begin != end; ++begin) {
199             Edge::Ptr edge = *begin;
200             if(skip_edges.find(edge) == skip_edges.end()) {
201                 SliceNode::Ptr parent =
202                     dyn_detail::boost::static_pointer_cast<SliceNode>(
203                         edge->source());
204                 if(done.find(parent) == done.end())
205                     ++pcnt;
206             }
207         }
208
209         queues[pcnt].nodes.insert(n);
210         queues[pcnt].order = pcnt;
211         order_map[n] = pcnt;
212
213         if(force_done)
214             done.insert(n);
215     }
216
217     // Mark a node complete, updating its children.
218     // Removes the node from the data structure
219     void mark_done(SliceNode::Ptr n) {
220         // First pull all of the children of this node
221         // that are not on the skip list
222
223         set<SliceNode::Ptr> children;
224
225         EdgeIterator begin, end;
226         n->outs(begin, end);
227         for (; begin != end; ++begin) {
228             Edge::Ptr edge = *begin;
229             if(skip_edges.find(edge) == skip_edges.end()) {
230                 SliceNode::Ptr child = 
231                     dyn_detail::boost::static_pointer_cast<SliceNode>(
232                         edge->target());
233                 if(remove(child))
234                     children.insert(child);
235             }
236         }
237
238         // remove n and set done
239         remove(n);
240         done.insert(n);
241
242         // put the children back
243         set<SliceNode::Ptr>::iterator cit = children.begin();
244         for( ; cit != children.end(); ++cit) {
245             insert(*cit); 
246         }
247     }
248     
249     bool is_done(SliceNode::Ptr n) const {
250         return done.find(n) == done.end();
251     }
252
253     set<Edge::Ptr> & skipEdges() { return skip_edges; }
254
255  private:
256     struct order_queue {
257         int order;
258         set<SliceNode::Ptr> nodes; 
259     };
260
261     set<Edge::Ptr> skip_edges; 
262     map<int,order_queue> queues;
263     map<SliceNode::Ptr, int> order_map;
264     set<SliceNode::Ptr> done;
265 };
266
267
268 // Do the previous, but use a Graph as a guide for
269 // performing forward substitution on the AST results
270 SymEval::Retval_t SymEval::expand(Graph::Ptr slice, Result_t &res) {
271    bool failedTranslation = false;
272    bool skippedInput = false;
273
274     //cout << "Calling expand" << endl;
275     // Other than the substitution this is pretty similar to the first example.
276     NodeIterator gbegin, gend;
277     slice->allNodes(gbegin, gend);
278
279     // Optimal ordering of search
280     ExpandOrder worklist;
281
282     std::queue<Node::Ptr> dfs_worklist;
283     for (; gbegin != gend; ++gbegin) {
284       Node::Ptr ptr = *gbegin;
285       dfs_worklist.push(ptr);
286     }
287
288     /* First, we'll do DFS to check for circularities in the graph;
289      * if so, mark them so we don't do infinite substitution */
290     std::map<Node::Ptr, int> state;
291     while (!dfs_worklist.empty()) {
292        Node::Ptr ptr = dfs_worklist.front(); dfs_worklist.pop();
293        dfs(ptr, state, worklist.skipEdges());
294     }
295
296     slice->allNodes(gbegin, gend);
297     for (; gbegin != gend; ++gbegin) {
298         expand_cerr << "adding " << (*gbegin)->format() << " to worklist" << endl;
299         Node::Ptr ptr = *gbegin;
300         SliceNode::Ptr sptr = 
301             dyn_detail::boost::static_pointer_cast<SliceNode>(ptr);
302         worklist.insert(sptr,false);
303     }
304
305     /* have a list
306      * for each node, process
307      * if processessing succeeded, remove the element
308      * if the size of the list has changed, continue */
309
310     while (1) {
311       SliceNode::Ptr aNode;
312       int order;
313
314       boost::tie(aNode,order) = worklist.pop_next();
315       if(order == -1) // empty
316         break;
317
318       if (!aNode->assign()) {
319           worklist.mark_done(aNode);
320           continue; // Could be a widen point
321       }
322
323       expand_cerr << "Visiting node " << aNode->assign()->format() 
324         << " order " << order << endl;
325
326       if (order != 0) {
327         cerr << "ERROR: order is non zero: " << order << endl;
328       }
329       assert(order == 0); // there are no loops
330
331       AST::Ptr prev = res[aNode->assign()];
332       Retval_t result = process(aNode, res, worklist.skipEdges()); 
333       AST::Ptr post = res[aNode->assign()];
334       switch (result) {
335          case FAILED:
336             return FAILED;
337             break;
338          case WIDEN_NODE:
339             // Okay...
340             break;
341          case FAILED_TRANSLATION:
342             failedTranslation = true;
343             break;
344          case SKIPPED_INPUT:
345             skippedInput = true;
346             break;
347          case SUCCESS:
348             break;
349       }
350
351       // We've visited this node, freeing its children
352       // to be visited in turn
353       worklist.mark_done(aNode);
354
355       if (post && !(post->equals(prev))) {
356         expand_cerr << "Adding successors to list, as new expansion " << endl
357             << "\t" << post->format() << endl 
358             << " != " << endl
359             << "\t" << (prev ? prev->format() : "<NULL>") << endl;
360         EdgeIterator oB, oE;
361         aNode->outs(oB, oE);
362         for (; oB != oE; ++oB) {
363             if(worklist.skipEdges().find(*oB) == worklist.skipEdges().end()) {
364                 SliceNode::Ptr out =
365                     dyn_detail::boost::static_pointer_cast<SliceNode>(
366                         (*oB)->target());
367                 worklist.insert(out);
368             }
369         }
370       }
371     }
372     if (failedTranslation) return FAILED_TRANSLATION;
373     else if (skippedInput) return SKIPPED_INPUT;
374     else return SUCCESS;
375 }
376
377 bool SymEval::expandInsn(const InstructionAPI::Instruction::Ptr insn,
378                          const uint64_t addr,
379                          Result_t &res) {
380
381    SymEvalPolicy policy(res, addr, insn->getArch(), insn);
382
383   SgAsmInstruction *roseInsn;
384   switch(insn->getArch()) {
385   case Arch_x86:  {
386     RoseInsnX86Factory fac;
387     roseInsn = fac.convert(insn, addr);
388     
389     SymbolicExpansion exp;
390     exp.expandX86(roseInsn, policy);
391     break;
392   }
393   case Arch_ppc32: {
394     RoseInsnPPCFactory fac;
395     roseInsn = fac.convert(insn, addr);
396
397     SymbolicExpansion exp;
398     exp.expandPPC(roseInsn, policy);
399     break;
400   }
401   default:
402     assert(0 && "Unimplemented symbolic expansion architecture");
403     break;
404   }
405
406   if (policy.failedTranslate()) {
407      cerr << "Warning: failed semantic translation of instruction " << insn->format() << endl;
408      return false;
409   }
410   return true;
411 }
412
413
414 SymEval::Retval_t SymEval::process(SliceNode::Ptr ptr,
415                                    Result_t &dbase,
416                                    std::set<Edge::Ptr> &skipEdges) {
417    bool failedTranslation;
418    bool skippedEdge = false;
419    bool skippedInput = false;
420    bool success = false;
421
422     std::map<AbsRegion, std::set<Assignment::Ptr> > inputMap;
423
424     expand_cerr << "Calling process on " << ptr->format() << endl;
425
426     // Don't try an expansion of a widen node...
427     if (!ptr->assign()) return WIDEN_NODE;
428
429     EdgeIterator begin, end;
430     ptr->ins(begin, end);
431
432     for (; begin != end; ++begin) {
433        SliceEdge::Ptr edge = dyn_detail::boost::static_pointer_cast<SliceEdge>(*begin);
434        SliceNode::Ptr source = dyn_detail::boost::static_pointer_cast<SliceNode>(edge->source());
435
436        // Skip this one to break a cycle.
437        if (skipEdges.find(edge) != skipEdges.end()) {
438          expand_cerr << "In process, skipping edge from " 
439                      << source->format() << endl;
440          skippedEdge = true;
441          continue;
442        }
443        
444        Assignment::Ptr assign = source->assign();
445        if (!assign) continue; // widen node
446        
447        expand_cerr << "Assigning input " << edge->data().format() 
448                    << " from assignment " << assign->format() << endl;
449        inputMap[edge->data()].insert(assign);
450     }
451     
452     expand_cerr << "\t Input map has size " << inputMap.size() << endl;
453     
454     // All of the expanded inputs are in the parameter dbase
455     // If not (like this one), add it
456     
457     AST::Ptr ast;
458     boost::tie(ast, failedTranslation) = SymEval::expand(ptr->assign());
459     //expand_cerr << "\t ... resulting in " << dbase.format() << endl;
460
461     // We have an AST. Now substitute in all of its predecessors.
462     for (std::map<AbsRegion, std::set<Assignment::Ptr> >::iterator iter = inputMap.begin();
463          iter != inputMap.end(); ++iter) {
464       // If we have multiple secondary definitions, we:
465       //   if all definitions are equal, use the first
466       //   otherwise, use nothing
467       AST::Ptr definition;
468
469       for (std::set<Assignment::Ptr>::iterator iter2 = iter->second.begin(); 
470            iter2 != iter->second.end(); ++iter2) {
471         AST::Ptr newDef = dbase[*iter2];
472         if (!definition) {
473           definition = newDef;
474           continue;
475         }
476         else if (definition->equals(newDef)) {
477           continue;
478         }
479         else {
480           // Not equal
481           definition = AST::Ptr(); 
482           skippedInput = true;
483           break;
484         }
485       }
486
487       
488       // The region used by the current assignment...
489       const AbsRegion &reg = iter->first;
490       
491       // Create an AST around this one
492       VariableAST::Ptr use = VariableAST::create(Variable(reg, ptr->addr()));
493       
494       if (!definition) {
495         // Can happen if we're expanding out of order, and is generally harmless.
496         continue;
497       }
498       
499       expand_cerr << "Before substitution: " << (ast ? ast->format() : "<NULL AST>") << endl;
500       
501       if (!ast) {
502         expand_cerr << "Skipping substitution because of null AST" << endl;
503       } else {
504         ast = AST::substitute(ast, use, definition);
505         success = true;
506       } 
507       //expand_cerr << "\t result is " << res->format() << endl;
508     }
509     expand_cerr << "Result of substitution: " << ptr->assign()->format() << " == " << (ast ? ast->format() : "<NULL AST>") << endl;
510     
511     // And attempt simplification again
512     ast = simplifyStack(ast, ptr->addr(), ptr->func());
513     expand_cerr << "Result of post-substitution simplification: " << ptr->assign()->format() << " == " 
514                 << (ast ? ast->format() : "<NULL AST>") << endl;
515     
516     dbase[ptr->assign()] = ast;
517     if (failedTranslation) return FAILED_TRANSLATION;
518     else if (skippedEdge || skippedInput) return SKIPPED_INPUT;
519     else if (success) return SUCCESS;
520     else return FAILED;
521 }
522
523 AST::Ptr SymEval::simplifyStack(AST::Ptr ast, Address addr, ParseAPI::Function *func) {
524   if (!ast) return ast;
525   // Let's experiment with simplification
526   StackAnalysis sA(func);
527   StackAnalysis::Height sp = sA.findSP(addr);
528   StackAnalysis::Height fp = sA.findFP(addr);
529   
530   StackVisitor sv(addr, func, sp, fp);
531
532   AST::Ptr simplified = ast->accept(&sv);
533
534   return simplified;
535 }