Debug output cleanning and ParseAPI manual update
[dyninst.git] / dataflowAPI / h / slicing.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30 // A simple forward slice using a search of the control flow graph.
31 // Templated on a function that says when to stop slicing.
32
33 #if !defined(_SLICING_H_)
34 #define _SLICING_H_
35
36 #include <vector>
37 #include "dyntypes.h"
38 #include <queue>
39 #include <set>
40 #include <unordered_set>
41 #include <map>
42 #include <unordered_map>
43 #include <list>
44 #include <stack>
45
46 #include "util.h"
47 #include "Node.h"
48 #include "Edge.h"
49
50 #include "AbslocInterface.h"
51
52 #include <boost/functional/hash.hpp>
53
54 namespace Dyninst {
55
56 namespace ParseAPI {
57   class Block;
58   class Edge;
59   class Function;
60 };
61
62 class Assignment;
63 class AbsRegion;
64 typedef boost::shared_ptr<Assignment> AssignmentPtr;
65
66 class Graph;
67 typedef boost::shared_ptr<Graph> GraphPtr;
68
69  namespace InstructionAPI {
70    class Instruction;
71  }
72  typedef boost::shared_ptr<InstructionAPI::Instruction> InstructionPtr;
73
74  class Slicer;
75
76 // Used in temp slicer; should probably
77 // replace OperationNodes when we fix up
78 // the DDG code.
79 class DATAFLOW_EXPORT SliceNode : public Node {
80  public:
81   typedef boost::shared_ptr<SliceNode> Ptr;
82       
83   static SliceNode::Ptr create(AssignmentPtr ptr,
84                                 ParseAPI::Block *block,
85                                 ParseAPI::Function *func) {
86     return Ptr(new SliceNode(ptr, block, func));
87   }
88       
89   ParseAPI::Block *block() const { return b_; };
90   ParseAPI::Function *func() const { return f_; };
91   Address addr() const;
92   AssignmentPtr assign() const { return a_; }
93       
94   Node::Ptr copy() { return Node::Ptr(); }
95   bool isVirtual() const { return false; }
96       
97   std::string format() const;
98       
99   virtual ~SliceNode() {};
100       
101  private:
102       
103  SliceNode(AssignmentPtr ptr,
104             ParseAPI::Block *block,
105             ParseAPI::Function *func) : 
106   a_(ptr), b_(block), f_(func) {};
107       
108   AssignmentPtr a_;
109   ParseAPI::Block *b_;
110   ParseAPI::Function *f_;
111
112   friend class Slicer;
113 };
114
115 class SliceEdge : public Edge {
116   public:
117    typedef boost::shared_ptr<SliceEdge> Ptr;
118
119    DATAFLOW_EXPORT static SliceEdge::Ptr create(SliceNode::Ptr source,
120                                                 SliceNode::Ptr target,
121                                                 AbsRegion const&data) {
122       return Ptr(new SliceEdge(source, target, data)); 
123    }
124
125    const AbsRegion &data() const { return data_; };
126
127   private:
128    SliceEdge(const SliceNode::Ptr source, 
129              const SliceNode::Ptr target,
130              AbsRegion const& data) 
131       : Edge(source, target), data_(data) {};
132    AbsRegion data_;
133 };
134
135 class Slicer {
136  public:
137   typedef std::pair<InstructionPtr, Address> InsnInstance;
138   typedef std::vector<InsnInstance> InsnVec;
139
140   DATAFLOW_EXPORT Slicer(AssignmentPtr a,
141          ParseAPI::Block *block,
142          ParseAPI::Function *func,
143          bool cache = true,
144          bool stackAnalysis = true);
145     
146   DATAFLOW_EXPORT static bool isWidenNode(Node::Ptr n);
147
148   class Predicates {
149     bool cache, controlFlowDep;
150
151   public:
152     typedef std::pair<ParseAPI::Function *, int> StackDepth_t;
153     typedef std::stack<StackDepth_t> CallStack_t;
154     DATAFLOW_EXPORT bool useCache() { return cache; }
155     DATAFLOW_EXPORT void setCache(bool val) { cache = val; }
156     DATAFLOW_EXPORT bool searchForControlFlowDep() { return controlFlowDep; }
157     DATAFLOW_EXPORT void setSearchForControlFlowDep(bool cfd) { controlFlowDep = cfd; }
158
159     DATAFLOW_EXPORT virtual bool allowImprecision() { return false; }
160     DATAFLOW_EXPORT virtual bool widenAtPoint(AssignmentPtr) { return false; }
161     DATAFLOW_EXPORT virtual bool endAtPoint(AssignmentPtr) { return false; }
162     DATAFLOW_EXPORT virtual bool followCall(ParseAPI::Function * /*callee*/,
163                                            CallStack_t & /*cs*/,
164                                            AbsRegion /*argument*/) { 
165        return false; 
166     }
167     DATAFLOW_EXPORT virtual std::vector<ParseAPI::Function *> 
168         followCallBackward(ParseAPI::Block * /*callerB*/,
169             CallStack_t & /*cs*/,
170             AbsRegion /*argument*/) {
171             std::vector<ParseAPI::Function *> vec;
172             return vec;
173         }
174     DATAFLOW_EXPORT virtual bool addPredecessor(AbsRegion /*reg*/) {
175         return true;
176     }
177     DATAFLOW_EXPORT virtual bool widenAtAssignment(const AbsRegion & /*in*/,
178                                                   const AbsRegion & /*out*/) { 
179        return false; 
180     }
181     DATAFLOW_EXPORT virtual ~Predicates() {};
182
183     // Callback function when adding a new node to the slice.
184     // Return true if we want to continue slicing
185     DATAFLOW_EXPORT virtual bool addNodeCallback(AssignmentPtr,
186                                                  std::set<ParseAPI::Edge*> &) { return true;}
187     DATAFLOW_EXPORT Predicates() : cache(true), controlFlowDep(false) {}                                                
188
189   };
190
191   DATAFLOW_EXPORT GraphPtr forwardSlice(Predicates &predicates);
192   
193   DATAFLOW_EXPORT GraphPtr backwardSlice(Predicates &predicates);
194
195  private:
196
197   typedef enum {
198     forward,
199     backward } Direction;
200
201   typedef std::map<ParseAPI::Block *, InsnVec> InsnCache;
202
203   // Our slicing is context-sensitive; that is, if we enter
204   // a function foo from a caller bar, all return edges
205   // from foo must enter bar. This makes an assumption that
206   // the return address is not modified, but hey. 
207   // We represent this as a list of call sites. This is redundant
208   // with the image_instPoint data structure, but hopefully that
209   // one will be going away. 
210
211   struct ContextElement {
212     // We can implicitly find the callsite given a block,
213     // since calls end blocks. It's easier to look up 
214     // the successor this way than with an address.
215
216     ParseAPI::Function *func;
217
218     // If non-NULL this must be an internal context
219     // element, since we have an active call site.
220     ParseAPI::Block *block;
221
222     // To enter or leave a function we must be able to
223     // map corresponding abstract regions. 
224     // In particular, we need to know the depth of the 
225     // stack in the caller.
226      int stackDepth;
227
228   ContextElement(ParseAPI::Function *f) : 
229     func(f), block(NULL), stackDepth(-1) {};
230   ContextElement(ParseAPI::Function *f, long depth) :
231     func(f), block(NULL), stackDepth(depth) {};
232   };
233
234   // This should be sufficient...
235   typedef std::deque<ContextElement> Context;
236
237   bool getStackDepth(ParseAPI::Function *func, ParseAPI::Block *block, Address callAddr, long &height);
238
239   // Add the newly called function to the given Context.
240   void pushContext(Context &context,
241                    ParseAPI::Function *callee,
242                    ParseAPI::Block *callBlock,
243                    long stackDepth);
244
245   // And remove it as appropriate
246   void popContext(Context &context);
247
248   // Where we are in a particular search...
249   struct Location {
250     // The block we're looking through
251     ParseAPI::Function *func;
252     ParseAPI::Block *block; // current block
253
254     // Where we are in the block
255     InsnVec::iterator current;
256     InsnVec::iterator end;
257
258     bool fwd;
259
260     InsnVec::reverse_iterator rcurrent;
261     InsnVec::reverse_iterator rend;
262
263     Address addr() const { if(fwd) return (*current).second; else return (*rcurrent).second;}
264
265   Location(ParseAPI::Function *f,
266            ParseAPI::Block *b) : func(f), block(b), fwd(true){};
267   Location() : func(NULL), block(NULL), fwd(true) {};
268   };
269     
270   typedef std::queue<Location> LocList;
271  
272   // Describes an abstract region, a minimal context
273   // (block and function), and the assignment that
274   // relates to that region (uses or defines it, 
275   // depending on slice direction)
276   //
277   // A slice is composed of Elements; SliceFrames 
278   // keep a list of the currently active elements
279   // that are at the `leading edge' of the 
280   // under-construction slice
281   struct Element {
282     Element(ParseAPI::Block * b,
283         ParseAPI::Function * f,
284         AbsRegion const& r,
285         Assignment::Ptr p)
286       : block(b),
287         func(f),
288         reg(r),
289         ptr(p)
290     { }
291
292     // basic comparator for ordering
293     bool operator<(const Element& el) const { 
294         if (ptr->addr() < el.ptr->addr()) { return true; }
295         if (el.ptr->addr() < ptr->addr()) { return false; }
296         if (ptr->out() < el.ptr->out()) { return true; }
297         return false;
298     }
299
300     ParseAPI::Block * block;
301     ParseAPI::Function * func;
302
303     AbsRegion reg;
304     Assignment::Ptr ptr;
305   };
306   bool ReachableFromBothBranches(ParseAPI::Edge *e, std::vector<Element> &newE);
307
308   // State for recursive slicing is a context, location pair
309   // and a list of AbsRegions that are being searched for.
310   struct SliceFrame {
311     SliceFrame(
312         Location const& l,
313         Context const& c)
314       : loc(l),
315         con(c),
316         valid(true)
317     { }
318     SliceFrame() : valid(true) { }
319     SliceFrame(bool v) : valid(v) { }
320
321     // Active slice nodes -- describe regions
322     // that are currently under scrutiny
323     std::map<AbsRegion, std::vector<Element> > active;
324     typedef std::map<AbsRegion, std::vector<Element> > ActiveMap;
325
326     Location loc;
327     Context con;
328     bool valid;
329
330     Address addr() const { return loc.addr(); }
331   };
332
333   // Used for keeping track of visited edges in the
334   // slicing search
335   struct CacheEdge {
336     CacheEdge(Address src, Address trg) : s(src), t(trg) { }
337     Address s;
338     Address t;
339
340     bool operator<(CacheEdge const& o) const {
341         if(s < o.s)
342             return true;
343         else if(o.s < s)
344             return false;
345         else if(t < o.t)
346             return true;
347         else
348             return false;
349     }
350   };
351
352     /* 
353      * An element that is a slicing `def' (where
354      * def means `definition' in the backward case
355      * and `use' in the forward case, along with
356      * the associated AbsRegion that labels the slicing
357      * edge.
358      *
359      * These two pieces of information, along with an 
360      * element describing the other end of the dependency,
361      * are what you need to create a slice edge.
362      */
363     struct Def {
364       Def(Element const& e, AbsRegion const& r) : ele(e), data(r) { } 
365       Element ele;
366       AbsRegion data;
367  
368       struct DefHasher {
369           size_t operator() (const Def &o) const {
370               return Assignment::AssignmentPtrHasher()(o.ele.ptr);
371           }
372       };
373       // only the Assignment::Ptr of an Element matters
374       // for comparison
375       bool operator<(Def const& o) const {
376           if(ele.ptr < o.ele.ptr)
377               return true;
378           else if(o.ele.ptr < ele.ptr)
379               return false;
380           else if(data < o.data)
381               return true;
382           else 
383               return false;
384       }
385
386       bool operator==(Def const &o) const {
387           if (ele.ptr != o.ele.ptr) return false;
388           return data == o.data;
389       }
390     };
391
392     /*
393      * A cache from AbsRegions -> Defs.
394      *
395      * Each node that has been visited in the search
396      * has a DefCache that reflects the resolution of
397      * any AbsRegions down-slice. If the node is visited
398      * again through a different search path (if the graph
399      * has fork-join structure), this caching prevents
400      * expensive recursion
401      */
402     class DefCache {
403       public:
404         DefCache() { }
405         ~DefCache() { }
406
407         // add the values from another defcache
408         void merge(DefCache const& o);
409    
410         // replace mappings in this cache with those
411         // from another 
412         void replace(DefCache const& o);
413
414         std::set<Def> & get(AbsRegion const& r) { 
415             return defmap[r];
416         }
417         bool defines(AbsRegion const& r) const {
418             return defmap.find(r) != defmap.end();
419         }
420
421         void print() const;
422
423       private:
424         std::map< AbsRegion, std::set<Def> > defmap;
425     
426     };
427
428     // For preventing insertion of duplicate edges
429     // into the slice graph
430     struct EdgeTuple {
431         EdgeTuple(SliceNode::Ptr src, SliceNode::Ptr dst, AbsRegion const& reg)
432           : s(src), d(dst), r(reg) { }
433         bool operator<(EdgeTuple const& o) const {
434             if(s < o.s)
435                 return true;
436             else if(o.s < s)
437                 return false;
438             else if(d < o.d)
439                 return true;
440             else if(o.d < d)
441                 return false;
442             else if(r < o.r)
443                 return true;
444             else
445                 return false;
446         }
447         bool operator == (EdgeTuple const &o) const {
448             if (s != o.s) return false;
449             if (d != o.d) return false;
450             return r == o.r;
451         }
452         SliceNode::Ptr s;
453         SliceNode::Ptr d;
454         AbsRegion r;
455     };
456
457   // Shift an abs region by a given stack offset
458   void shiftAbsRegion(AbsRegion const&callerReg,
459                       AbsRegion &calleeReg,
460                       long stack_depth,
461                       ParseAPI::Function *callee);
462
463     // Shift all of the abstract regions active in the current frame
464     void shiftAllAbsRegions(
465         SliceFrame & cur,
466         long stack_depth,
467         ParseAPI::Function *callee);
468
469   /*
470    * Internal slicing support routines follow. See the
471    * implementation file for descriptions of what these
472    * routines actually do to implement slicing.
473    */
474     GraphPtr sliceInternal(Direction dir,
475             Predicates &predicates);
476     void sliceInternalAux(
477             GraphPtr g,
478             Direction dir,
479             Predicates &p,
480             SliceFrame &cand,
481             bool skip,
482             std::map<CacheEdge, std::set<AbsRegion> > & visited,
483             std::map<Address,DefCache> & single,
484             std::map<Address, DefCache>& cache);
485
486     bool updateAndLink(
487             GraphPtr g,
488             Direction dir,
489             SliceFrame & cand,
490             DefCache & cache,
491             Predicates &p);
492
493     void updateAndLinkFromCache(
494             GraphPtr g,
495             Direction dir,
496             SliceFrame & f,
497             DefCache & cache);
498
499     void removeBlocked(
500             SliceFrame & f,
501             std::set<AbsRegion> const& block);
502
503     bool stopSlicing(SliceFrame::ActiveMap& active, 
504                      GraphPtr g,
505                      Address addr,
506                      Direction dir);
507
508
509     void markVisited(
510             std::map<CacheEdge, std::set<AbsRegion> > & visited,
511             CacheEdge const& e,
512             SliceFrame::ActiveMap const& active);
513
514     void cachePotential(
515             Direction dir,
516             Assignment::Ptr assn,
517             DefCache & cache);
518
519     bool findMatch(
520             GraphPtr g,
521             Direction dir,
522             SliceFrame const& cand,
523             AbsRegion const& cur,
524             Assignment::Ptr assn,
525             std::vector<Element> & matches,
526             DefCache & cache);
527
528     bool getNextCandidates(
529             Direction dir,
530             Predicates & p,
531             SliceFrame const& cand,
532             std::vector<SliceFrame> & newCands);
533
534     /* forward slicing */
535
536     bool getSuccessors(
537             Predicates &p,
538             SliceFrame const& cand,
539             std::vector<SliceFrame> & newCands);
540
541
542     bool handleCall(
543             Predicates & p,
544             SliceFrame & cur,
545             bool & err);
546
547     bool followCall(
548             Predicates & p,
549             ParseAPI::Block * target,
550             SliceFrame & cur);
551
552     bool handleCallDetails(
553             SliceFrame & cur,
554             ParseAPI::Block * caller_block);
555
556     bool handleReturn(
557             Predicates & p,
558             SliceFrame & cur,
559             bool & err);
560
561     void handleReturnDetails(
562             SliceFrame & cur);
563
564     bool handleDefault(
565             Direction dir,
566             Predicates & p,
567             ParseAPI::Edge * e,
568             SliceFrame & cur,
569             bool & err);
570
571     /* backwards slicing */
572
573     bool getPredecessors(
574             Predicates &p,
575             SliceFrame const& cand,
576             std::vector<SliceFrame> & newCands);
577
578     bool handleCallBackward(
579             Predicates & p,
580             SliceFrame const& cand,
581             std::vector<SliceFrame> & newCands,
582             ParseAPI::Edge * e,
583             bool & err);
584
585     std::vector<ParseAPI::Function *> followCallBackward(
586             Predicates & p,
587             SliceFrame const& cand,
588             AbsRegion const& reg,
589             ParseAPI::Block * caller_block);
590
591     bool handleCallDetailsBackward(
592             SliceFrame & cur);
593
594     bool handleReturnBackward(
595             Predicates & p,
596             SliceFrame const& cand,
597             SliceFrame & newCand,
598             ParseAPI::Edge * e,
599             bool & err);
600
601     bool handleReturnDetailsBackward(
602             SliceFrame & cur,
603             ParseAPI::Block * caller_block);
604
605     bool followReturn(
606             Predicates & p,
607             SliceFrame const& cand,
608             ParseAPI::Block * source);
609     void handlePredecessorEdge(ParseAPI::Edge* e,
610                                Predicates& p,
611                                SliceFrame const& cand,
612                                std::vector<SliceFrame> & newCands,
613                                bool& err,
614                                SliceFrame& nf);
615   
616
617     /* general slicing support */
618   
619     void constructInitialFrame(
620             Direction dir, 
621             SliceFrame & initFrame);
622     
623     void widenAll(GraphPtr graph, Direction dir, SliceFrame const& frame);
624   
625   bool kills(AbsRegion const& reg, Assignment::Ptr &assign);
626
627   void widen(GraphPtr graph, Direction dir, Element const&source);
628
629   void insertPair(GraphPtr graph,
630                   Direction dir,
631                   Element const&source,
632                   Element const&target,
633           AbsRegion const& data);
634
635   void insertPair(GraphPtr graph,
636                   Direction dir,
637                   SliceNode::Ptr& source,
638                   SliceNode::Ptr& target,
639           AbsRegion const& data);
640
641   void convertInstruction(InstructionPtr,
642                           Address,
643                           ParseAPI::Function *,
644                           ParseAPI::Block *,
645                           std::vector<AssignmentPtr> &);
646
647   void fastForward(Location &loc, Address addr);
648
649   void fastBackward(Location &loc, Address addr);
650
651   SliceNode::Ptr widenNode();
652
653   void markAsEndNode(GraphPtr ret, Direction dir, Element &current);
654   
655   void markAsExitNode(GraphPtr ret, Element &current);
656
657   void markAsEntryNode(GraphPtr ret, Element &current);
658
659   void getInsns(Location &loc);
660
661   void getInsnsBackward(Location &loc);
662
663   void setAliases(Assignment::Ptr, Element &);
664
665   SliceNode::Ptr createNode(Element const&);
666
667   void cleanGraph(GraphPtr g);
668
669   void promotePlausibleNodes(GraphPtr g, Direction d);
670
671   ParseAPI::Block *getBlock(ParseAPI::Edge *e,
672                             Direction dir);
673   
674
675   void insertInitialNode(GraphPtr ret, Direction dir, SliceNode::Ptr aP);
676
677   void mergeRecursiveCaches(std::map<Address, DefCache>& sc, std::map<Address, DefCache>& c, Address a);
678
679   InsnCache insnCache_;
680
681   AssignmentPtr a_;
682   ParseAPI::Block *b_;
683   ParseAPI::Function *f_;
684
685
686   // Assignments map to unique slice nodes
687   std::unordered_map<AssignmentPtr, SliceNode::Ptr, Assignment::AssignmentPtrHasher> created_;
688
689   // cache to prevent edge duplication
690   struct EdgeTupleHasher {
691     size_t operator() (const EdgeTuple& et) const {
692         size_t seed = (size_t)(et.s.get());
693         boost::hash_combine( seed , (size_t)(et.d.get()));
694         return seed;
695     }
696   };
697   std::unordered_map<EdgeTuple, int, EdgeTupleHasher> unique_edges_;
698
699   // map of previous active maps. these are used to end recursion.
700   typedef std::map<AbsRegion, std::set<Element> > PrevMap;
701   std::map<Address, PrevMap> prev_maps;
702
703   // set of plausible entry/exit nodes.
704   std::set<SliceNode::Ptr> plausibleNodes;
705
706   // a stack and set of addresses that mirror our recursion.
707   // these are used to detect loops and properly merge cache.
708   std::deque<Address> addrStack;
709   std::set<Address> addrSet;
710
711   AssignmentConverter converter;
712
713   SliceNode::Ptr widen_;
714  public: 
715   // A set of edges that have been visited during slicing,
716   // which can be used for external users to figure out
717   // which part of code has been analyzed
718   std::set<ParseAPI::Edge*> visitedEdges;
719 };
720
721 }
722
723 #endif