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