Added support for "callpath sensitive" backward slicing.
[dyninst.git] / dataflowAPI / src / slicing.C
1 // Simple search mechanism to assist in short-range slicing.
2
3 #include <set>
4 #include <vector>
5 #include <queue>
6 #include "dataflowAPI/h/Absloc.h"
7 #include "dataflowAPI/h/AbslocInterface.h"
8 #include "Instruction.h"
9
10 #include "dataflowAPI/h/stackanalysis.h"
11
12 #include "dataflowAPI/h/slicing.h"
13
14 #include "dynutil/h/Graph.h"
15 #include "instructionAPI/h/Instruction.h"
16 #include "instructionAPI/h/InstructionDecoder.h"
17
18 #include "debug_dataflow.h"
19
20 #include "CFG.h"
21 #include "CodeSource.h"
22 #include "CodeObject.h"
23
24 using namespace Dyninst;
25 using namespace InstructionAPI;
26 using namespace std;
27 using namespace ParseAPI;
28
29 Address AssignNode::addr() const { 
30   if (a_)
31     return a_->addr();
32   return 0;
33 }
34
35 bool containsCall(ParseAPI::Block *block) {
36   // We contain a call if the out-edges include
37   // either a CALL or a CALL_FT edge
38   const Block::edgelist &targets = block->targets();
39   Block::edgelist::iterator eit = targets.begin();
40   for (; eit != targets.end(); ++eit) {
41     ParseAPI::Edge *edge = *eit;
42     if (edge->type() == CALL) return true;
43   }
44   return false;
45 }
46
47 bool containsRet(ParseAPI::Block *block) {
48   // We contain a call if the out-edges include
49   // either a CALL or a CALL_FT edge
50   const Block::edgelist &targets = block->targets();
51   Block::edgelist::iterator eit = targets.begin();
52   for (; eit != targets.end(); ++eit) {
53     ParseAPI::Edge *edge = *eit;
54     if (edge->type() == RET) return true;
55   }
56   return false;
57 }
58
59 static void getInsnInstances(ParseAPI::Block *block,
60                       Slicer::InsnVec &insns) {
61   Offset off = block->start();
62   const unsigned char *ptr = (const unsigned char *)block->region()->getPtrToInstruction(off);
63   if (ptr == NULL) return;
64   InstructionDecoder d(ptr, block->size(), block->obj()->cs()->getArch());
65   while (off < block->end()) {
66     insns.push_back(std::make_pair(d.decode(), off));
67     off += insns.back().first->size();
68   }
69 }
70
71 ParseAPI::Function *getEntryFunc(ParseAPI::Block *block) {
72   return block->obj()->findFuncByEntry(block->region(), block->start());
73 }
74
75 // Constructor. Takes the initial point we slice from. 
76
77 // TODO: make this function-less interprocedural. That would throw the
78 // stack analysis for a loop, but is generally doable...
79 Slicer::Slicer(Assignment::Ptr a,
80                ParseAPI::Block *block,
81                ParseAPI::Function *func) : 
82   a_(a),
83   b_(block),
84   f_(func),
85   converter(true) {
86   df_init_debug();
87 };
88
89 Graph::Ptr Slicer::forwardSlice(Predicates &predicates) {
90   return sliceInternal(forward, predicates);
91 }
92
93 Graph::Ptr Slicer::backwardSlice(Predicates &predicates) {
94   return sliceInternal(backward, predicates);
95 }
96
97 Graph::Ptr Slicer::sliceInternal(Direction dir,
98                                  Predicates &p) {
99   Graph::Ptr ret = Graph::createGraph();
100
101   // This does the work of forward or backwards slicing;
102   // the few different operations are flagged by the
103   // direction.
104
105   // e tells us when we should end (naturally)
106   // w tells us when we should end and widen
107   // c determines whether a call should be followed or skipped
108   // a does ???
109   
110   Element initial;
111   constructInitialElement(initial, dir);
112   //     constructInitialElementBackward(initial);
113
114   AssignNode::Ptr aP = createNode(initial);
115   if (dir == forward)
116       slicing_cerr << "Inserting entry node " << aP << "/" << aP->format() << endl;
117   else
118       slicing_cerr << "Inserting exit node " << aP << "/" << aP->format() << endl;
119
120   insertInitialNode(ret, dir, aP);
121
122   Elements worklist;
123   worklist.push(initial);
124
125   std::set<Assignment::Ptr> visited;
126
127   while (!worklist.empty()) {
128     Element current = worklist.front(); worklist.pop();
129
130     assert(current.ptr);
131
132     // As a note, anything we see here has already been added to the
133     // return graph. We're trying to decide whether to keep searching.
134
135     // Don't get stuck in a loop
136     if (visited.find(current.ptr) != visited.end()) {
137       slicing_cerr << "\t Already visited, skipping" << endl;
138       continue;
139     }
140     else {
141       visited.insert(current.ptr);
142     }
143
144     slicing_cerr << "\tSlicing from " << current.ptr->format() << endl;
145     
146     // Do we widen out? This should check the defined
147     // abstract region...
148     if (p.widenAtPoint(current.ptr)) {
149       slicing_cerr << "\t\t... widens slice" << endl;
150       widen(ret, dir, current);
151       continue;
152     }
153
154     // Do we stop here according to the end predicate?
155     if (p.endAtPoint(current.ptr)) {
156       slicing_cerr << "\t\t... ends slice" << endl;
157       markAsEndNode(ret, dir, current);
158       continue;
159     }
160
161     Elements found;
162     
163     if (!getMatchingElements(current, found, p, dir)) {
164       widen(ret, dir, current);
165     }
166     // We actually want to fall through; it's possible to have
167     // a partially successful search.
168
169     while (!found.empty()) {
170       Element target = found.front(); found.pop();
171       if (target.valid) {
172          insertPair(ret, dir, current, target);
173          worklist.push(target);
174       }
175       else {
176          widen(ret, dir, current);
177       }
178     }
179   }
180
181   cleanGraph(ret);
182   slicing_cerr << "... done" << endl;
183   return ret;
184 }
185   
186 bool Slicer::getMatchingElements(Element &current,
187                                  Elements &found,
188                                  Predicates &p,
189                                  Direction dir) {
190   bool ret = true;
191   if (dir == forward) {
192     // Find everyone who uses what this ptr defines
193     current.reg = current.ptr->out();
194     
195     if (!search(current, found, p, 0, // Index doesn't matter as
196                 // it's set when we find a match
197                 forward)) {
198       ret = false;
199     }
200   }
201   else {
202     assert(dir == backward);
203
204     // Find everyone who defines what this instruction uses
205     vector<AbsRegion> inputs = current.ptr->inputs();
206
207     for (unsigned int k = 0; k < inputs.size(); ++k) {
208       // Do processing on each input
209       current.reg = inputs[k];
210
211       if (!search(current, found, p, k, backward)) {
212         slicing_cerr << "\t\t... backward search failed" << endl;
213         ret = false;
214       }
215     }
216   }
217   return ret;
218 }
219
220 bool Slicer::getStackDepth(ParseAPI::Function *func, Address callAddr, long &height) {
221   StackAnalysis sA(func);
222
223   StackAnalysis::Height heightSA = sA.findSP(callAddr);
224
225   // Ensure that analysis has been performed.
226
227   assert(!heightSA.isTop());
228   
229   if (heightSA.isBottom()) {
230     return false;
231   }
232   
233   height = heightSA.height();
234   
235   // The height will include the effects of the call
236   // Should check the region... 
237
238   //slicing_cerr << "Get stack depth at " << std::hex << callAddr
239   //<< std::dec << " " << (int) height << endl;
240
241   return true;
242 }
243
244 void Slicer::pushContext(Context &context,
245                          ParseAPI::Function *callee,
246                          ParseAPI::Block *callBlock,
247                          long stackDepth) {
248   slicing_cerr << "pushContext with " << context.size() << " elements" << endl;
249   assert(context.front().block == NULL);
250   context.front().block = callBlock;
251
252   slicing_cerr << "\t" 
253                << (context.front().func ? context.front().func->name() : "NULL")
254                << ", " 
255                << context.front().stackDepth 
256                << endl;
257
258     context.push_front(ContextElement(callee, stackDepth));
259 };
260
261 void Slicer::popContext(Context &context) {
262   context.pop_front();
263
264   context.front().block = NULL;
265 }
266
267 void Slicer::shiftAbsRegion(AbsRegion &callerReg,
268                             AbsRegion &calleeReg,
269                             long stack_depth,
270                             ParseAPI::Function *callee) {
271   if (callerReg.absloc() == Absloc()) {
272     // Typed, so just keep the same type and call it a day
273     calleeReg = callerReg;
274     return;
275   }
276   else {
277     assert(callerReg.type() == Absloc::Unknown);
278     
279     const Absloc &callerAloc = callerReg.absloc();
280     if (callerAloc.type() != Absloc::Stack) {
281       calleeReg = AbsRegion(callerAloc);
282     }
283     else {
284       if (stack_depth == -1) {
285         // Oops
286         calleeReg = AbsRegion(Absloc::Stack);
287         return;
288       }
289       else {
290         //slicing_cerr << "*** Shifting caller absloc " << callerAloc.off()
291         //<< " by stack depth " << stack_depth 
292         //<< " and setting to function " << callee->name() << endl;
293         calleeReg = AbsRegion(Absloc(callerAloc.off() - stack_depth,
294                                      0, // Entry point has region 0 by definition
295                                      callee));
296       }
297     }
298   }
299 }
300
301 bool Slicer::handleCallDetails(AbsRegion &reg,
302                         Context &context,
303                         ParseAPI::Block *callerBlock,
304                         ParseAPI::Function *callee) {
305   ParseAPI::Function *caller = context.front().func;
306   AbsRegion newReg = reg;
307
308   long stack_depth;
309   if (!getStackDepth(caller, callerBlock->end(), stack_depth)) {
310     return false;
311   }
312
313   // Increment the context
314   pushContext(context, callee, callerBlock, stack_depth);
315
316   // Translate the AbsRegion from caller to callee
317   shiftAbsRegion(reg,
318                  newReg,
319                  stack_depth,
320                  callee);
321
322   //slicing_cerr << "After call, context has " << context.size() << " elements" << endl;
323   //slicing_cerr << "\t" << (context.front().func ? context.front().func->name() : "NULL")
324   //       << ", " << context.front().stackDepth << endl;
325
326   reg = newReg;
327   return true;
328 }
329
330 void Slicer::handleReturnDetails(AbsRegion &reg,
331                                  Context &context) {
332   // We need to add back the appropriate stack depth, basically
333   // reversing what we did in handleCall
334
335   //  slicing_cerr << "Return: context has " << context.size() << " elements" << endl;
336   //slicing_cerr << "\t" << (context.front().func ? context.front().func->name() : "NULL")
337   //<< ", " << context.front().stackDepth << endl;
338
339   long stack_depth = context.front().stackDepth;
340
341   popContext(context);
342
343   assert(!context.empty());
344
345   slicing_cerr << "\t" << (context.front().func ?
346                            context.front().func->name() : "NULL")
347                << ", " << context.front().stackDepth << endl;
348
349
350   AbsRegion newRegion;
351   shiftAbsRegion(reg, newRegion,
352                  -1*stack_depth,
353                  context.front().func);
354   reg = newRegion;
355 }
356
357 bool Slicer::handleReturnDetailsBackward(AbsRegion &reg,
358         Context &context,
359         ParseAPI::Block *callerBlock,
360         ParseAPI::Function *callee)
361 {
362     ParseAPI::Function * caller = context.front().func;
363     AbsRegion newReg = reg;
364
365     long stack_depth;
366     if (!getStackDepth(caller, callerBlock->end(), stack_depth)) {
367         return false;
368     }
369
370     // Increment the context
371     pushContext(context, callee, callerBlock, stack_depth);
372
373     // Translate the AbsRegion from caller to callee
374     shiftAbsRegion(reg,
375             newReg,
376             stack_depth,
377             callee);
378
379     reg = newReg;
380     return true;
381 }
382
383 bool Slicer::handleCallDetailsBackward(AbsRegion &reg,
384                                         Context &context,
385                                         ParseAPI::Block * callBlock,
386                                         ParseAPI::Function *caller) {
387
388     ParseAPI::Function * callee = context.front().func;
389     Address callBlockLastInsn = callBlock->lastInsnAddr();
390
391     long stack_depth;
392     if (!getStackDepth(caller, callBlockLastInsn, stack_depth)) {
393         return false;
394     }
395     
396     popContext(context);
397
398     assert(!context.empty());
399
400     slicing_cerr << "\t" << (context.front().func ?
401             context.front().func->name() : "NULL")
402         << ", " << context.front().stackDepth << endl;
403
404     AbsRegion newRegion;
405     shiftAbsRegion(reg, newRegion,
406             -1*stack_depth,
407             caller);
408
409     reg = newRegion;
410     
411     return true;
412 }
413
414 // Given a <location> this function returns a list of successors.
415 // If the successor is in a different function the searched-for
416 // AbsRegion should be updated (along with the context) but this
417 // doesn't handle that. 
418
419 bool Slicer::getSuccessors(Element &current,
420                            Elements &succ,
421                            Predicates &p) {
422   // Simple case: if we're not at the end of the instructions
423   // in this block, then add the next one and return.
424
425   InsnVec::iterator next = current.loc.current;
426   next++;
427
428   if (next != current.loc.end) {
429     Element newElement = current;
430     // We're in the same context since we're in the same block
431     // Also, AbsRegion
432     // But update the Location
433     newElement.loc.current = next;
434     succ.push(newElement);
435
436     slicing_cerr << "\t\t\t\t Adding intra-block successor " << newElement.reg.format() << endl;
437
438     return true;
439   }
440
441   bool ret = true;
442   // At the end of the block: set up the next blocks.
443   bool err = false;
444
445   if (containsCall(current.loc.block)) {
446     Element newElement;
447     slicing_cerr << "\t\t Handling call:";
448     if (handleCall(current.loc.block,
449                    current,
450                    newElement,
451                    p, 
452                    err)) {
453       slicing_cerr << " succeeded, err " << err << endl;
454       succ.push(newElement);
455     }
456     else {
457       slicing_cerr << " failed, err " << err << endl;
458     }
459   }
460   else if (containsRet(current.loc.block)) {
461     Element newElement;
462     slicing_cerr << "\t\t Handling return:";
463     if (handleReturn(current.loc.block,
464                      current,
465                      newElement,
466                      p,
467                      err)) {
468       slicing_cerr << " succeeded, err " << err << endl;
469       succ.push(newElement);
470     }
471     else {
472       slicing_cerr << " failed, err " << err << endl;
473     }
474   }
475   else {
476     const Block::edgelist &targets = current.loc.block->targets();
477     Block::edgelist::iterator eit = targets.begin();
478     for (; eit != targets.end(); ++eit) {
479       Element newElement;
480       if ((*eit)->sinkEdge()) {
481          newElement.valid = false;
482          succ.push(newElement);
483       }
484       else if (handleDefault(*eit,
485                              forward,
486                              current,
487                              newElement,
488                              p,
489                              err)) {
490          succ.push(newElement);
491       }
492       else {
493          cerr << " failed handleDefault, err " << err << endl;
494       }
495     }
496   }
497   if (err) {
498     ret = false;
499   }
500   
501   return ret;
502 }
503
504 bool Slicer::getPredecessors(Element &current, 
505                              Elements &pred,
506                              Predicates &p) 
507 {
508     // Simple case: if we're not at the beginning of the instructions
509     // in the block, then add the previous one and return
510     InsnVec::reverse_iterator prev = current.loc.rcurrent;
511     prev++;
512
513     if (prev != current.loc.rend) {
514         Element newElement = current;
515         // We're in the same context since we're in the same block
516         // Also, AbsRegion
517         // But update the Location
518         newElement.loc.rcurrent = prev;
519
520         if (p.addPredecessor(newElement.reg)) {
521             pred.push(newElement);
522
523             slicing_cerr << "\t\t\t\t Adding intra-block predecessor " 
524                 << std::hex << newElement.loc.addr() << " "  
525                 << newElement.reg.format() << endl;
526             slicing_cerr << "\t\t\t\t Current region is " << current.reg.format() 
527                 << endl;
528         }
529         return true;
530     }
531     
532     bool ret = true;
533     bool err = false;
534
535     Element newElement;
536     Elements newElements;
537     //SingleContext epredSC(current.loc.func, true, true);
538     //Interproc epred;
539     SingleContextOrInterproc epred(current.loc.func, true, true);
540
541     const Block::edgelist &sources = current.loc.block->sources();
542     Block::edgelist::iterator eit = sources.begin(&epred);
543     for ( ; eit != sources.end(); ++eit) {   
544       switch ((*eit)->type()) {
545       case CALL:
546         slicing_cerr << "\t\t Handling call:";
547         if (handleCallBackward(*eit,
548                     current,
549                     newElements,
550                     p,
551                     err)) {
552             slicing_cerr << " succeeded, err " <<err << endl;
553             while (newElements.size()) {
554                 newElement = newElements.front(); newElements.pop();
555                 pred.push(newElement);
556             }
557         }
558         break;
559       case RET:
560         slicing_cerr << "\t\t Handling return:";
561         if (handleReturnBackward(*eit,
562                     current,
563                     newElement,
564                     p,
565                     err)) {
566             slicing_cerr << " succeeded, err " << err << endl;
567             pred.push(newElement);
568         }
569         break;
570       default:
571             Element newElement;
572         if (handleDefault((*eit),
573                           backward,
574                           current,
575                           newElement,
576                           p,
577                           err)) {
578             pred.push(newElement);
579         }    
580       }
581     }
582     if (err) {
583       ret = false;
584     }
585     return ret;
586  
587 }
588
589
590 bool Slicer::handleDefault(ParseAPI::Edge *e,
591         Direction dir,
592         Element &current,
593         Element &newElement,
594         Predicates &,
595         bool &) {
596     // Since we're in the same function we can keep the AbsRegion
597     // and Context. Instead we only need to update the Location
598     newElement = current;
599
600     if (dir == forward) {
601         newElement.loc.block = e->trg();
602
603         // Cache the new vector of instruction instances and get iterators into it
604         getInsns(newElement.loc);
605     } else {
606         newElement.loc.block = e->src();
607
608         getInsnsBackward(newElement.loc);
609     }
610
611     return true;
612
613 }
614
615 bool Slicer::handleCall(ParseAPI::Block *block,
616                         Element &current,
617                         Element &newElement,
618                         Predicates &p,
619                         bool &err) {
620   ParseAPI::Block *callee = NULL;
621   ParseAPI::Edge *funlink = NULL;
622
623   const Block::edgelist &targets = block->targets();
624   Block::edgelist::iterator eit = targets.begin();
625   for (; eit != targets.end(); ++eit) {
626     if ((*eit)->sinkEdge()) {
627         err = true;
628         continue;
629     }
630     if ((*eit)->type() == CALL) {
631       callee = (*eit)->trg();
632     }
633     else if ((*eit)->type() == CALL_FT) {
634       funlink = (*eit);
635     }
636   }
637
638   if (followCall(callee, forward, current, p)) {
639     if (!callee) {
640       err = true;
641       return false;
642     }
643
644     newElement = current;
645     // Update location
646     newElement.loc.block = callee;
647     newElement.loc.func = getEntryFunc(callee);
648     getInsns(newElement.loc);
649     
650     // HandleCall updates both an AbsRegion and a context...
651     if (!handleCallDetails(newElement.reg,
652                            newElement.con,
653                            current.loc.block,
654                            newElement.loc.func)) {
655       err = true;
656       return false;
657     }
658   }
659   else {
660     // Use the funlink
661     if (!funlink) {
662       // ???
663       return false;
664     }
665     if (!handleDefault(funlink,
666                        forward,
667                        current,
668                        newElement,
669                        p,
670                        err)) {
671       err = true;
672       return false;
673     }
674   }
675   
676   return true;
677 }
678
679 bool Slicer::handleCallBackward(ParseAPI::Edge *edge,
680         Element &current,
681         Elements &newElements,
682         Predicates &p,
683         bool &)
684 {
685     Element newElement = current;
686
687     newElement.loc.block = edge->src();
688
689     /* We don't know which function the caller block belongs to,
690      * follow each possibility */
691     vector<Function *> funcs;
692     newElement.loc.block->getFuncs(funcs);
693     vector<Function *> funcsToFollow = followCallBackward(&funcs, backward, current, p);
694     vector<Function *>::iterator fit;
695     for (fit = funcsToFollow.begin(); fit != funcsToFollow.end(); ++fit) {
696         Element curElement = newElement;
697         curElement.con.push_back(ContextElement(*fit));
698
699         // Pop AbsRegion and Context
700         if (!handleCallDetailsBackward(curElement.reg,
701                     curElement.con,
702                     curElement.loc.block,
703                     *fit)) {
704             return false;
705         }
706
707         curElement.loc.func = *fit;
708         getInsnsBackward(curElement.loc);
709         newElements.push(curElement);
710     }
711
712     return true;
713 }
714
715 bool Slicer::handleReturn(ParseAPI::Block *,
716                           Element &current,
717                           Element &newElement,
718                           Predicates &,
719                           bool &err) {
720   // As handleCallEdge, but now with 50% fewer calls
721   newElement = current;
722
723   // Find out the successor block...
724   Context callerCon = newElement.con;
725   callerCon.pop_front();
726
727   if (callerCon.empty()) {
728     return false;
729   }
730
731   ParseAPI::Block *retBlock = NULL;
732
733   const Block::edgelist &targets = current.loc.block->targets();
734   Block::edgelist::iterator eit = targets.begin();
735   for (; eit != targets.end(); ++eit) {
736     if ((*eit)->type() == CALL_FT) {
737       retBlock = (*eit)->trg();
738       break;
739     }
740   }
741   if (!retBlock) {
742     err = true;
743     return false;
744   }
745
746   // Pops absregion and context
747   handleReturnDetails(newElement.reg,
748                       newElement.con);
749   
750   newElement.loc.func = newElement.con.front().func;
751   newElement.loc.block = retBlock;
752   getInsns(newElement.loc);
753   return true;
754 }
755
756 bool Slicer::handleReturnBackward(ParseAPI::Edge *edge,
757         Element &current,
758         Element &newElement,
759         Predicates &p,
760         bool &err)
761 {
762     ParseAPI::Block * callee = edge->src();
763
764     if (followReturn(callee, backward, current, p)) {
765         if (!callee) {
766             err = true;
767             return false;
768         }
769
770         newElement = current;
771
772         // Update location
773         newElement.loc.block = callee;
774         newElement.loc.func = getEntryFunc(callee);
775         getInsnsBackward(newElement.loc);
776
777         // handleReturnDetailsBackward updates both an AbsRegion and a context
778         if (!handleReturnDetailsBackward(newElement.reg,
779                     newElement.con,
780                     current.loc.block,
781                     newElement.loc.func)) {
782             err = true;
783             return false;
784         }
785         return true;
786     }
787
788     return false;
789 }
790
791 bool Slicer::search(Element &initial,
792                     Elements &succ,
793                     Predicates &p,
794                     int index,
795                     Direction dir) {
796   bool ret = true;
797   
798   Assignment::Ptr source = initial.ptr;
799
800   Elements worklist;
801   
802   if (dir == forward)  {
803       slicing_cerr << "\t\t Getting forward successors from " << initial.ptr->format()
804           << " - " << initial.reg.format() << endl;
805   } else {
806       slicing_cerr << "\t\t Getting backward predecessors from " << initial.ptr->format()
807           << " - " << initial.reg.format() << endl;
808   }
809
810   if (!getNextCandidates(initial, worklist, p, dir))
811     ret = false;
812
813   // Need this so we don't get trapped in a loop (literally) 
814   std::set<Address> visited;
815   
816   while (!worklist.empty()) {
817     Element current = worklist.front();
818     worklist.pop();
819
820     if (!current.valid) {
821        // This marks a widen spot
822        succ.push(current);
823        continue;
824     }
825
826     if (visited.find(current.addr()) != visited.end()) {
827       continue;
828     }
829     else {
830       visited.insert(current.addr());
831     }
832     
833     // After this point we treat current as a scratch space to scribble in
834     // and return...
835
836     // Split the instruction up
837     std::vector<Assignment::Ptr> assignments;
838     Instruction::Ptr insn;
839     if (dir == forward)
840         insn = current.loc.current->first;
841     else
842         insn = current.loc.rcurrent->first;
843     convertInstruction(insn,
844             current.addr(),
845             current.loc.func,
846             assignments);
847     bool keepGoing = true;
848
849     for (std::vector<Assignment::Ptr>::iterator iter = assignments.begin();
850          iter != assignments.end(); ++iter) {
851       Assignment::Ptr &assign = *iter;
852
853       findMatches(current, assign, dir, index, succ);
854
855       if (kills(current, assign)) {
856         keepGoing = false;
857       }
858     }
859     if (keepGoing) {
860       if (!getNextCandidates(current, worklist, p, dir)) {
861         ret = false;
862       }
863     }
864   }
865   return ret;
866 }
867
868 bool Slicer::getNextCandidates(Element &current, Elements &worklist,
869                                Predicates &p, Direction dir) {
870   if (dir == forward) {
871     return getSuccessors(current, worklist, p);
872   }
873   else {
874     return getPredecessors(current, worklist, p);
875   }
876 }
877
878 void Slicer::findMatches(Element &current, Assignment::Ptr &assign, Direction dir, int index, Elements &succ) {
879   if (dir == forward) {
880     // We compare the AbsRegion in current to the inputs
881     // of assign
882     
883     for (unsigned k = 0; k < assign->inputs().size(); ++k) {
884       const AbsRegion &uReg = assign->inputs()[k];
885       if (current.reg.contains(uReg)) {
886         // We make a copy of each Element for each Assignment...
887         current.ptr = assign;
888         current.usedIndex = k;
889         succ.push(current);
890       }
891     }
892   }
893   else {
894     assert(dir == backward);
895     const AbsRegion &oReg = assign->out();
896     slicing_cerr << "\t\t\t\t\tComparing current " 
897                  << current.reg.format() << " to candidate "
898                  << oReg.format() << endl;
899     if (current.reg.contains(oReg)) {
900        slicing_cerr << "\t\t\t\t\t\tMatch!" << endl;
901       current.ptr = assign;
902       current.usedIndex = index;
903       succ.push(current);
904     }
905   }
906 }
907
908 bool Slicer::kills(Element &current, Assignment::Ptr &assign) {
909   // Did we find a definition of the same abstract region?
910   // TBD: overlaps ins't quite the right thing here. "contained
911   // by" would be better, but we need to get the AND/OR
912   // of abslocs hammered out.
913
914   if (assign->out().type() != Absloc::Unknown) {
915     // A region assignment can never kill
916     return false; 
917   }
918
919   return current.reg.contains(assign->out());
920 }
921
922 AssignNode::Ptr Slicer::createNode(Element &elem) {
923   if (created_.find(elem.ptr) != created_.end()) {
924     return created_[elem.ptr];
925   }
926   AssignNode::Ptr newNode = AssignNode::create(elem.ptr, elem.loc.block, elem.loc.func);
927   created_[elem.ptr] = newNode;
928   return newNode;
929 }
930
931 std::string AssignNode::format() const {
932   if (!a_) {
933     return "<NULL>";
934   }
935
936   stringstream ret;
937   ret << "(" << a_->format() << "@" <<
938     f_->name() << ")";
939   return ret.str();
940 }
941
942 void Slicer::convertInstruction(Instruction::Ptr insn,
943                                 Address addr,
944                                 ParseAPI::Function *func,
945                                 std::vector<Assignment::Ptr> &ret) {
946   converter.convert(insn,
947                     addr,
948                     func,
949                     ret);
950   return;
951 }
952
953 void Slicer::getInsns(Location &loc) {
954
955   InsnCache::iterator iter = insnCache_.find(loc.block);
956   if (iter == insnCache_.end()) {
957     getInsnInstances(loc.block, insnCache_[loc.block]);
958   }
959   
960   loc.current = insnCache_[loc.block].begin();
961   loc.end = insnCache_[loc.block].end();
962 }
963
964 void Slicer::getInsnsBackward(Location &loc) {
965     InsnCache::iterator iter = insnCache_.find(loc.block);
966     if (iter == insnCache_.end()) {
967       getInsnInstances(loc.block, insnCache_[loc.block]);
968     }
969
970     loc.rcurrent = insnCache_[loc.block].rbegin();
971     loc.rend = insnCache_[loc.block].rend();
972 }
973
974 void Slicer::insertPair(Graph::Ptr ret,
975                         Direction dir,
976                         Element &source,
977                         Element &target) {
978   AssignNode::Ptr s = createNode(source);
979   AssignNode::Ptr t = createNode(target);
980
981   if (dir == forward) {
982       ret->insertPair(s, t);
983
984       // Also record which input to t is defined by s
985       slicing_cerr << "adding assignment with usedIndex = " << target.usedIndex << endl;
986       t->addAssignment(s, target.usedIndex);
987   } else {
988       ret->insertPair(t, s);
989       slicing_cerr << "adding assignment with usedIndex = " << target.usedIndex << endl;
990       s->addAssignment(t, target.usedIndex);
991   }
992 }
993
994 void Slicer::widen(Graph::Ptr ret,
995                    Direction dir,
996                    Element &e) {
997   if (dir == forward) {
998     ret->insertPair(createNode(e),
999                     widenNode());
1000     ret->insertExitNode(widenNode());
1001   }
1002   else {
1003     ret->insertPair(widenNode(), createNode(e));
1004     ret->insertEntryNode(widenNode());
1005   }
1006 }
1007
1008 AssignNode::Ptr Slicer::widenNode() {
1009   if (widen_) {
1010     return widen_;
1011   }
1012
1013   widen_ = AssignNode::create(Assignment::Ptr(),
1014                               NULL, NULL);
1015   return widen_;
1016 }
1017
1018 void Slicer::markAsEndNode(Graph::Ptr ret, Direction dir, Element &e) {
1019   if (dir == forward) {    
1020     ret->insertExitNode(createNode(e));
1021   }
1022   else {
1023     ret->insertEntryNode(createNode(e));
1024   }
1025 }
1026
1027 void Slicer::fastForward(Location &loc, Address
1028                          addr) {
1029   while ((loc.current != loc.end) &&
1030          (loc.addr() < addr)) {
1031     loc.current++;
1032   }
1033   assert(loc.current != loc.end);
1034   assert(loc.addr() == addr);
1035 }
1036
1037 void Slicer::fastBackward(Location &loc, Address addr) {
1038     while ((loc.rcurrent != loc.rend) &&
1039          (loc.addr() > addr)) {
1040     loc.rcurrent++;
1041   }
1042     
1043   assert(loc.rcurrent != loc.rend);
1044   assert(loc.addr() == addr);  
1045 }
1046
1047 void Slicer::cleanGraph(Graph::Ptr ret) {
1048   
1049   // Clean the graph up
1050   
1051   // TODO: make this more efficient by backwards traversing.
1052   // For now, I know that we're generating graphs with tons of
1053   // unnecessary flag sets (which are immediately killed) and so
1054   // we don't have long non-exiting chains, we have "fuzz"
1055   
1056   NodeIterator nbegin, nend;
1057   ret->allNodes(nbegin, nend);
1058   
1059   std::list<Node::Ptr> toDelete;
1060   
1061   for (; nbegin != nend; ++nbegin) {
1062     AssignNode::Ptr foozle =
1063       dyn_detail::boost::dynamic_pointer_cast<AssignNode>(*nbegin);
1064     //cerr << "Checking " << foozle << "/" << foozle->format() << endl;
1065     if ((*nbegin)->hasOutEdges()) {
1066       //cerr << "\t has out edges, leaving in" << endl;
1067       
1068         // This cleans up case where we ended a backward slice
1069         // but never got to mark the node as an entry node
1070         if (!(*nbegin)->hasInEdges()) {
1071             ret->markAsEntryNode(foozle);
1072         }
1073       continue;
1074     }
1075     if (ret->isExitNode(*nbegin)) {
1076       //cerr << "\t is exit node, leaving in" << endl;
1077       continue;
1078     }
1079     //cerr << "\t deleting" << endl;
1080     toDelete.push_back(*nbegin);
1081   }
1082
1083   for (std::list<Node::Ptr>::iterator tmp =
1084          toDelete.begin(); tmp != toDelete.end(); ++tmp) {
1085     ret->deleteNode(*tmp);
1086   }
1087 }
1088
1089 bool Slicer::followCall(ParseAPI::Block *target, Direction dir, Element &current, Predicates &p)
1090 {
1091   // We provide the call stack and the potential callee.
1092   // It returns whether we follow the call or not.
1093   
1094   // A NULL callee indicates an indirect call.
1095   // TODO on that one...
1096   
1097   // Find the callee
1098   assert(dir == forward);
1099   ParseAPI::Function *callee = (target ? getEntryFunc(target) : NULL);
1100   // Create a call stack
1101   std::stack<std::pair<ParseAPI::Function *, int> > callStack;
1102   for (Context::reverse_iterator calls = current.con.rbegin();
1103        calls != current.con.rend();
1104        ++calls)
1105     {
1106       if (calls->func)  {
1107         //cerr << "Adding " << calls->func->name() << " to call stack" << endl;
1108         callStack.push(std::make_pair<ParseAPI::Function*, int>(calls->func, calls->stackDepth));
1109       }
1110     }
1111   //cerr << "Calling followCall with stack and " << (callee ? callee->name() : "<NULL>") << endl;
1112   // FIXME: assuming that this is not a PLT function, since I have no idea at present.
1113   // -- BW, April 2010
1114   return p.followCall(callee, callStack, current.reg);
1115 }
1116
1117 vector<Function *> Slicer::followCallBackward(vector<Function *> * callers,
1118         Direction dir,
1119         Element &current,
1120         Predicates &p) {
1121     assert(dir == backward);
1122
1123     // Create the call stack
1124     std::stack<std::pair<ParseAPI::Function *, int> > callStack;
1125     for (Context::reverse_iterator calls = current.con.rbegin();
1126             calls != current.con.rend();
1127             ++calls) {
1128         if (calls->func) {
1129             callStack.push(std::make_pair<Function *, int>(calls->func, calls->stackDepth));
1130         }
1131     }
1132     return p.followCallBackward(callers, callStack, current.reg);
1133 }
1134
1135 bool Slicer::followReturn(ParseAPI::Block *source,
1136                             Direction dir,
1137                             Element &current,
1138                             Predicates &p)
1139 {
1140     assert(dir == backward);
1141     ParseAPI::Function * callee = (source ? getEntryFunc(source) : NULL);
1142     // Create a call stack
1143     std::stack<std::pair<ParseAPI::Function *, int> > callStack;
1144     for (Context::reverse_iterator calls = current.con.rbegin();
1145             calls != current.con.rend();
1146             ++calls) {
1147         if (calls->func) {
1148             callStack.push(std::make_pair<ParseAPI::Function *, int>(calls->func, calls->stackDepth));
1149         }
1150     }
1151     return p.followCall(callee, callStack, current.reg);
1152 }
1153
1154 ParseAPI::Block *Slicer::getBlock(ParseAPI::Edge *e,
1155                                    Direction dir) {
1156   return ((dir == forward) ? e->trg() : e->src());
1157 }
1158
1159 bool Slicer::isWidenNode(Node::Ptr n) {
1160   AssignNode::Ptr foozle =
1161     dyn_detail::boost::dynamic_pointer_cast<AssignNode>(n);
1162   if (!foozle) return false;
1163   if (!foozle->assign()) return true;
1164   return false;
1165 }
1166
1167 void Slicer::insertInitialNode(GraphPtr ret, Direction dir, AssignNode::Ptr aP) {
1168   if (dir == forward) {
1169     // Entry node
1170     ret->insertEntryNode(aP);
1171   }
1172   else {
1173     ret->insertExitNode(aP);
1174   }
1175 }
1176   
1177
1178 void Slicer::constructInitialElement(Element &initial, Direction dir) {
1179   // Cons up the first Element. We need a context, a location, and an
1180   // abstract region
1181   ContextElement context(f_);
1182   initial.con.push_front(ContextElement(f_));
1183   initial.loc = Location(f_, b_);
1184   initial.reg = a_->out();
1185   initial.ptr = a_;
1186
1187   if (dir == forward) {
1188     initial.loc.fwd = true;
1189     getInsns(initial.loc);
1190     fastForward(initial.loc, a_->addr());
1191   }
1192   else {
1193     initial.loc.fwd = false;
1194     getInsnsBackward(initial.loc);
1195     fastBackward(initial.loc, a_->addr());
1196   }
1197 }   
1198