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