One byte read can produce bound [0,255], but it is possible that an one byte read...
[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     
144   DATAFLOW_EXPORT static bool isWidenNode(Node::Ptr n);
145
146   class Predicates {
147   public:
148     typedef std::pair<ParseAPI::Function *, int> StackDepth_t;
149     typedef std::stack<StackDepth_t> CallStack_t;
150
151     DATAFLOW_EXPORT virtual bool allowImprecision() { return false; }
152     DATAFLOW_EXPORT virtual bool widenAtPoint(AssignmentPtr) { return false; }
153     DATAFLOW_EXPORT virtual bool endAtPoint(AssignmentPtr) { return false; }
154     DATAFLOW_EXPORT virtual bool followCall(ParseAPI::Function * /*callee*/,
155                                            CallStack_t & /*cs*/,
156                                            AbsRegion /*argument*/) { 
157        return false; 
158     }
159     DATAFLOW_EXPORT virtual std::vector<ParseAPI::Function *> 
160         followCallBackward(ParseAPI::Block * /*callerB*/,
161             CallStack_t & /*cs*/,
162             AbsRegion /*argument*/) {
163             std::vector<ParseAPI::Function *> vec;
164             return vec;
165         }
166     DATAFLOW_EXPORT virtual bool addPredecessor(AbsRegion /*reg*/) {
167         return true;
168     }
169     DATAFLOW_EXPORT virtual bool widenAtAssignment(const AbsRegion & /*in*/,
170                                                   const AbsRegion & /*out*/) { 
171        return false; 
172     }
173     DATAFLOW_EXPORT virtual ~Predicates() {};
174
175     // Callback function when adding a new node to the slice.
176     // Return true if we want to continue slicing
177     DATAFLOW_EXPORT virtual bool addNodeCallback(AssignmentPtr,
178                                                  std::set<ParseAPI::Edge*> &) { return true;}
179
180   };
181
182   DATAFLOW_EXPORT GraphPtr forwardSlice(Predicates &predicates);
183   
184   DATAFLOW_EXPORT GraphPtr backwardSlice(Predicates &predicates);
185
186  private:
187
188   typedef enum {
189     forward,
190     backward } Direction;
191
192   typedef std::map<ParseAPI::Block *, InsnVec> InsnCache;
193
194   // Our slicing is context-sensitive; that is, if we enter
195   // a function foo from a caller bar, all return edges
196   // from foo must enter bar. This makes an assumption that
197   // the return address is not modified, but hey. 
198   // We represent this as a list of call sites. This is redundant
199   // with the image_instPoint data structure, but hopefully that
200   // one will be going away. 
201
202   struct ContextElement {
203     // We can implicitly find the callsite given a block,
204     // since calls end blocks. It's easier to look up 
205     // the successor this way than with an address.
206
207     ParseAPI::Function *func;
208
209     // If non-NULL this must be an internal context
210     // element, since we have an active call site.
211     ParseAPI::Block *block;
212
213     // To enter or leave a function we must be able to
214     // map corresponding abstract regions. 
215     // In particular, we need to know the depth of the 
216     // stack in the caller.
217      int stackDepth;
218
219   ContextElement(ParseAPI::Function *f) : 
220     func(f), block(NULL), stackDepth(-1) {};
221   ContextElement(ParseAPI::Function *f, long depth) :
222     func(f), block(NULL), stackDepth(depth) {};
223   };
224
225   // This should be sufficient...
226   typedef std::deque<ContextElement> Context;
227
228   bool getStackDepth(ParseAPI::Function *func, ParseAPI::Block *block, Address callAddr, long &height);
229
230   // Add the newly called function to the given Context.
231   void pushContext(Context &context,
232                    ParseAPI::Function *callee,
233                    ParseAPI::Block *callBlock,
234                    long stackDepth);
235
236   // And remove it as appropriate
237   void popContext(Context &context);
238
239   // Where we are in a particular search...
240   struct Location {
241     // The block we're looking through
242     ParseAPI::Function *func;
243     ParseAPI::Block *block; // current block
244
245     // Where we are in the block
246     InsnVec::iterator current;
247     InsnVec::iterator end;
248
249     bool fwd;
250
251     InsnVec::reverse_iterator rcurrent;
252     InsnVec::reverse_iterator rend;
253
254     Address addr() const { if(fwd) return (*current).second; else return (*rcurrent).second;}
255
256   Location(ParseAPI::Function *f,
257            ParseAPI::Block *b) : func(f), block(b), fwd(true){};
258   Location() : func(NULL), block(NULL), fwd(true) {};
259   };
260     
261   typedef std::queue<Location> LocList;
262  
263   // Describes an abstract region, a minimal context
264   // (block and function), and the assignment that
265   // relates to that region (uses or defines it, 
266   // depending on slice direction)
267   //
268   // A slice is composed of Elements; SliceFrames 
269   // keep a list of the currently active elements
270   // that are at the `leading edge' of the 
271   // under-construction slice
272   struct Element {
273     Element(ParseAPI::Block * b,
274         ParseAPI::Function * f,
275         AbsRegion const& r,
276         Assignment::Ptr p)
277       : block(b),
278         func(f),
279         reg(r),
280         ptr(p)
281     { }
282
283     // basic comparator for ordering
284     bool operator<(const Element& el) const { 
285         if (ptr->addr() < el.ptr->addr()) { return true; }
286         if (el.ptr->addr() < ptr->addr()) { return false; }
287         if (ptr->out() < el.ptr->out()) { return true; }
288         return false;
289     }
290
291     ParseAPI::Block * block;
292     ParseAPI::Function * func;
293
294     AbsRegion reg;
295     Assignment::Ptr ptr;
296   };
297   bool ReachableFromBothBranches(ParseAPI::Edge *e, std::vector<Element> &newE);
298
299   // State for recursive slicing is a context, location pair
300   // and a list of AbsRegions that are being searched for.
301   struct SliceFrame {
302     SliceFrame(
303         Location const& l,
304         Context const& c,
305         bool f)
306       : loc(l),
307         con(c),
308         valid(true),
309         firstCond(f)
310     { }
311     SliceFrame() : valid(true), firstCond(true) { }
312     SliceFrame(bool v) : valid(v), firstCond(true) { }
313
314     // Active slice nodes -- describe regions
315     // that are currently under scrutiny
316     std::map<AbsRegion, std::vector<Element> > active;
317     typedef std::map<AbsRegion, std::vector<Element> > ActiveMap;
318
319     Location loc;
320     Context con;
321     bool valid;
322     bool firstCond;
323
324     Address addr() const { return loc.addr(); }
325   };
326
327   // Used for keeping track of visited edges in the
328   // slicing search
329   struct CacheEdge {
330     CacheEdge(Address src, Address trg) : s(src), t(trg) { }
331     Address s;
332     Address t;
333
334     bool operator<(CacheEdge const& o) const {
335         if(s < o.s)
336             return true;
337         else if(o.s < s)
338             return false;
339         else if(t < o.t)
340             return true;
341         else
342             return false;
343     }
344   };
345
346     /* 
347      * An element that is a slicing `def' (where
348      * def means `definition' in the backward case
349      * and `use' in the forward case, along with
350      * the associated AbsRegion that labels the slicing
351      * edge.
352      *
353      * These two pieces of information, along with an 
354      * element describing the other end of the dependency,
355      * are what you need to create a slice edge.
356      */
357     struct Def {
358       Def(Element const& e, AbsRegion const& r) : ele(e), data(r) { } 
359       Element ele;
360       AbsRegion data;
361  
362       struct DefHasher {
363           size_t operator() (const Def &o) const {
364               return Assignment::AssignmentPtrHasher()(o.ele.ptr);
365           }
366       };
367       // only the Assignment::Ptr of an Element matters
368       // for comparison
369       bool operator<(Def const& o) const {
370           if(ele.ptr < o.ele.ptr)
371               return true;
372           else if(o.ele.ptr < ele.ptr)
373               return false;
374           else if(data < o.data)
375               return true;
376           else 
377               return false;
378       }
379
380       bool operator==(Def const &o) const {
381           if (ele.ptr != o.ele.ptr) return false;
382           return data == o.data;
383       }
384     };
385
386     /*
387      * A cache from AbsRegions -> Defs.
388      *
389      * Each node that has been visited in the search
390      * has a DefCache that reflects the resolution of
391      * any AbsRegions down-slice. If the node is visited
392      * again through a different search path (if the graph
393      * has fork-join structure), this caching prevents
394      * expensive recursion
395      */
396     class DefCache {
397       public:
398         DefCache() { }
399         ~DefCache() { }
400
401         // add the values from another defcache
402         void merge(DefCache const& o);
403    
404         // replace mappings in this cache with those
405         // from another 
406         void replace(DefCache const& o);
407
408         std::set<Def> & get(AbsRegion const& r) { 
409             return defmap[r];
410         }
411         bool defines(AbsRegion const& r) const {
412             return defmap.find(r) != defmap.end();
413         }
414
415         void print() const;
416
417       private:
418         std::map< AbsRegion, std::set<Def> > defmap;
419     
420     };
421
422     // For preventing insertion of duplicate edges
423     // into the slice graph
424     struct EdgeTuple {
425         EdgeTuple(SliceNode::Ptr src, SliceNode::Ptr dst, AbsRegion const& reg)
426           : s(src), d(dst), r(reg) { }
427         bool operator<(EdgeTuple const& o) const {
428             if(s < o.s)
429                 return true;
430             else if(o.s < s)
431                 return false;
432             else if(d < o.d)
433                 return true;
434             else if(o.d < d)
435                 return false;
436             else if(r < o.r)
437                 return true;
438             else
439                 return false;
440         }
441         bool operator == (EdgeTuple const &o) const {
442             if (s != o.s) return false;
443             if (d != o.d) return false;
444             return r == o.r;
445         }
446         SliceNode::Ptr s;
447         SliceNode::Ptr d;
448         AbsRegion r;
449     };
450
451   // Shift an abs region by a given stack offset
452   void shiftAbsRegion(AbsRegion const&callerReg,
453                       AbsRegion &calleeReg,
454                       long stack_depth,
455                       ParseAPI::Function *callee);
456
457     // Shift all of the abstract regions active in the current frame
458     void shiftAllAbsRegions(
459         SliceFrame & cur,
460         long stack_depth,
461         ParseAPI::Function *callee);
462
463   /*
464    * Internal slicing support routines follow. See the
465    * implementation file for descriptions of what these
466    * routines actually do to implement slicing.
467    */
468     GraphPtr sliceInternal(Direction dir,
469             Predicates &predicates);
470     void sliceInternalAux(
471             GraphPtr g,
472             Direction dir,
473             Predicates &p,
474             SliceFrame &cand,
475             bool skip,
476             std::map<CacheEdge, std::set<AbsRegion> > & visited,
477             std::map<Address,DefCache> & single,
478             std::map<Address, DefCache>& cache);
479
480     bool updateAndLink(
481             GraphPtr g,
482             Direction dir,
483             SliceFrame & cand,
484             DefCache & cache,
485             Predicates &p);
486
487     void updateAndLinkFromCache(
488             GraphPtr g,
489             Direction dir,
490             SliceFrame & f,
491             DefCache & cache);
492
493     void removeBlocked(
494             SliceFrame & f,
495             std::set<AbsRegion> const& block);
496
497     bool stopSlicing(SliceFrame::ActiveMap& active, 
498                      GraphPtr g,
499                      Address addr,
500                      Direction dir);
501
502
503     void markVisited(
504             std::map<CacheEdge, std::set<AbsRegion> > & visited,
505             CacheEdge const& e,
506             SliceFrame::ActiveMap const& active);
507
508     void cachePotential(
509             Direction dir,
510             Assignment::Ptr assn,
511             DefCache & cache);
512
513     bool findMatch(
514             GraphPtr g,
515             Direction dir,
516             SliceFrame const& cand,
517             AbsRegion const& cur,
518             Assignment::Ptr assn,
519             std::vector<Element> & matches,
520             DefCache & cache);
521
522     bool getNextCandidates(
523             Direction dir,
524             Predicates & p,
525             SliceFrame const& cand,
526             std::vector<SliceFrame> & newCands);
527
528     /* forward slicing */
529
530     bool getSuccessors(
531             Predicates &p,
532             SliceFrame const& cand,
533             std::vector<SliceFrame> & newCands);
534
535
536     bool handleCall(
537             Predicates & p,
538             SliceFrame & cur,
539             bool & err);
540
541     bool followCall(
542             Predicates & p,
543             ParseAPI::Block * target,
544             SliceFrame & cur);
545
546     bool handleCallDetails(
547             SliceFrame & cur,
548             ParseAPI::Block * caller_block);
549
550     bool handleReturn(
551             Predicates & p,
552             SliceFrame & cur,
553             bool & err);
554
555     void handleReturnDetails(
556             SliceFrame & cur);
557
558     bool handleDefault(
559             Direction dir,
560             Predicates & p,
561             ParseAPI::Edge * e,
562             SliceFrame & cur,
563             bool & err);
564
565     /* backwards slicing */
566
567     bool getPredecessors(
568             Predicates &p,
569             SliceFrame const& cand,
570             std::vector<SliceFrame> & newCands);
571
572     bool handleCallBackward(
573             Predicates & p,
574             SliceFrame const& cand,
575             std::vector<SliceFrame> & newCands,
576             ParseAPI::Edge * e,
577             bool & err);
578
579     std::vector<ParseAPI::Function *> followCallBackward(
580             Predicates & p,
581             SliceFrame const& cand,
582             AbsRegion const& reg,
583             ParseAPI::Block * caller_block);
584
585     bool handleCallDetailsBackward(
586             SliceFrame & cur);
587
588     bool handleReturnBackward(
589             Predicates & p,
590             SliceFrame const& cand,
591             SliceFrame & newCand,
592             ParseAPI::Edge * e,
593             bool & err);
594
595     bool handleReturnDetailsBackward(
596             SliceFrame & cur,
597             ParseAPI::Block * caller_block);
598
599     bool followReturn(
600             Predicates & p,
601             SliceFrame const& cand,
602             ParseAPI::Block * source);
603     void handlePredecessorEdge(ParseAPI::Edge* e,
604                                Predicates& p,
605                                SliceFrame const& cand,
606                                std::vector<SliceFrame> & newCands,
607                                bool& err,
608                                SliceFrame& nf);
609   
610
611     /* general slicing support */
612   
613     void constructInitialFrame(
614             Direction dir, 
615             SliceFrame & initFrame);
616     
617     void widenAll(GraphPtr graph, Direction dir, SliceFrame const& frame);
618   
619   bool kills(AbsRegion const& reg, Assignment::Ptr &assign);
620
621   void widen(GraphPtr graph, Direction dir, Element const&source);
622
623   void insertPair(GraphPtr graph,
624                   Direction dir,
625                   Element const&source,
626                   Element const&target,
627           AbsRegion const& data);
628
629   void insertPair(GraphPtr graph,
630                   Direction dir,
631                   SliceNode::Ptr& source,
632                   SliceNode::Ptr& target,
633           AbsRegion const& data);
634
635   void convertInstruction(InstructionPtr,
636                           Address,
637                           ParseAPI::Function *,
638                           ParseAPI::Block *,
639                           std::vector<AssignmentPtr> &);
640
641   void fastForward(Location &loc, Address addr);
642
643   void fastBackward(Location &loc, Address addr);
644
645   SliceNode::Ptr widenNode();
646
647   void markAsEndNode(GraphPtr ret, Direction dir, Element &current);
648   
649   void markAsExitNode(GraphPtr ret, Element &current);
650
651   void markAsEntryNode(GraphPtr ret, Element &current);
652
653   void getInsns(Location &loc);
654
655   void getInsnsBackward(Location &loc);
656
657   void setAliases(Assignment::Ptr, Element &);
658
659   SliceNode::Ptr createNode(Element const&);
660
661   void cleanGraph(GraphPtr g);
662
663   void promotePlausibleNodes(GraphPtr g, Direction d);
664
665   ParseAPI::Block *getBlock(ParseAPI::Edge *e,
666                             Direction dir);
667   
668
669   void insertInitialNode(GraphPtr ret, Direction dir, SliceNode::Ptr aP);
670
671   void mergeRecursiveCaches(std::map<Address, DefCache>& sc, std::map<Address, DefCache>& c, Address a);
672
673   InsnCache insnCache_;
674
675   AssignmentPtr a_;
676   ParseAPI::Block *b_;
677   ParseAPI::Function *f_;
678
679
680   // Assignments map to unique slice nodes
681   std::unordered_map<AssignmentPtr, SliceNode::Ptr, Assignment::AssignmentPtrHasher> created_;
682
683   // cache to prevent edge duplication
684   struct EdgeTupleHasher {
685     size_t operator() (const EdgeTuple& et) const {
686         size_t seed = (size_t)(et.s.get());
687         boost::hash_combine( seed , (size_t)(et.d.get()));
688         return seed;
689     }
690   };
691   std::unordered_map<EdgeTuple, int, EdgeTupleHasher> unique_edges_;
692
693   // map of previous active maps. these are used to end recursion.
694   typedef std::map<AbsRegion, std::set<Element> > PrevMap;
695   std::map<Address, PrevMap> prev_maps;
696
697   // set of plausible entry/exit nodes.
698   std::set<SliceNode::Ptr> plausibleNodes;
699
700   // a stack and set of addresses that mirror our recursion.
701   // these are used to detect loops and properly merge cache.
702   std::deque<Address> addrStack;
703   std::set<Address> addrSet;
704
705   AssignmentConverter converter;
706
707   SliceNode::Ptr widen_;
708  public: 
709   // A set of edges that have been visited during slicing,
710   // which can be used for external users to figure out
711   // which part of code has been analyzed
712   std::set<ParseAPI::Edge*> visitedEdges;
713 };
714
715 }
716
717 #endif