Use lists of -Dcap and -Dbug defines so we can get the test suite to pull them in...
[dyninst.git] / dyninstAPI / src / BPatch_addressSpace.C
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
31 #define BPATCH_FILE
32
33 #include "binaryEdit.h"
34 #include "inst.h"
35 #include "instP.h"
36 #include "function.h" // Dyninst::PatchAPI::PatchFunction
37 #include "codeRange.h"
38 #include "addressSpace.h"
39 #include "dynProcess.h"
40 #include "debug.h"
41
42 #include "mapped_module.h"
43
44 #include "BPatch_libInfo.h"
45 #include "BPatch.h"
46 #include "BPatch_thread.h"
47 #include "BPatch_function.h"
48 #include "BPatch_point.h"
49
50 #include "BPatch_private.h"
51
52 #include "ast.h"
53
54 #include "BPatch_addressSpace.h"
55
56 #include "BPatch_instruction.h"
57
58 #include "mapped_object.h"
59
60 #include <sstream>
61 #include "Parsing.h"
62
63 #include "Command.h"
64 #include "Relocation/DynInstrumenter.h"
65
66 #include "PatchMgr.h"
67
68 using Dyninst::PatchAPI::Patcher;
69 using Dyninst::PatchAPI::DynInsertSnipCommand;
70 using Dyninst::PatchAPI::DynReplaceFuncCommand;
71 using Dyninst::PatchAPI::DynModifyCallCommand;
72 using Dyninst::PatchAPI::DynRemoveCallCommand;
73
74 BPatch_addressSpace::BPatch_addressSpace() :
75    image(NULL)
76 {
77 }
78
79 BPatch_addressSpace::~BPatch_addressSpace()
80 {}
81
82
83 BPatch_function *BPatch_addressSpace::findOrCreateBPFunc(Dyninst::PatchAPI::PatchFunction* ifunc,
84                                                          BPatch_module *bpmod)
85 {
86    func_instance *fi = static_cast<func_instance *>(ifunc);
87    if (!bpmod)
88       bpmod = image->findOrCreateModule(fi->mod());
89    assert(bpmod);
90    if (bpmod->func_map.count(ifunc)) {
91       BPatch_function *bpf = bpmod->func_map[ifunc];
92       assert(bpf);
93       assert(bpf->func == ifunc);
94       return bpf;
95    }
96
97    // Find the module that contains the function
98    if (bpmod == NULL && fi->mod() != NULL) {
99       bpmod = getImage()->findModule(fi->mod()->fileName().c_str());
100    }
101
102    // findModule has a tendency to make new function objects... so
103    // check the map again
104    if (bpmod->func_map.count(ifunc)) {
105       BPatch_function *bpf = bpmod->func_map[ifunc];
106       assert(bpf);
107       assert(bpf->func == ifunc);
108       return bpf;
109    }
110
111    BPatch_function *ret = new BPatch_function(this, fi, bpmod);
112    assert( ret != NULL );
113    assert(ret->func == ifunc);
114    return ret;
115 }
116
117
118
119
120 BPatch_point *BPatch_addressSpace::findOrCreateBPPoint(BPatch_function *bpfunc,
121                                                        Dyninst::PatchAPI::Point *p,
122                                                        BPatch_procedureLocation pointType)
123 {
124    instPoint *ip = static_cast<instPoint *>(p);
125    assert(ip);
126    func_instance *fi = static_cast<func_instance *>(ip->func());
127    if (!fi) return NULL; // PatchAPI can create function-less points, but we can't represent them as BPatch_points
128
129    BPatch_module *mod = image->findOrCreateModule(fi->mod());
130    assert(mod);
131
132    if (mod->instp_map.count(ip))
133       return mod->instp_map[ip];
134
135    if (pointType == BPatch_locUnknownLocation) {
136       cerr << "Error: point type not specified!" << endl;
137       assert(0);
138       return NULL;
139    }
140
141    AddressSpace *lladdrSpace = fi->proc();
142    if (!bpfunc)
143       bpfunc = findOrCreateBPFunc(fi, mod);
144
145    assert(bpfunc->func == ip->func());
146    std::pair<instPoint *, instPoint *> pointsToUse = instPoint::getInstpointPair(ip);
147
148    BPatch_point *pt = new BPatch_point(this, bpfunc,
149                                        pointsToUse.first, pointsToUse.second,
150                                        pointType, lladdrSpace);
151    mod->instp_map[ip] = pt;
152
153    return pt;
154 }
155
156 BPatch_variableExpr *BPatch_addressSpace::findOrCreateVariable(int_variable *v,
157                                                                BPatch_type *type)
158 {
159    BPatch_module *mod = image->findOrCreateModule(v->mod());
160    assert(mod);
161    if (mod->var_map.count(v))
162       return mod->var_map[v];
163
164    if (!type) {
165       SymtabAPI::Type *stype = v->ivar()->svar()->getType();
166
167       if (stype){
168          type = BPatch_type::findOrCreateType(stype);
169       }else{
170          type = BPatch::bpatch->type_Untyped;
171       }
172    }
173
174    BPatch_variableExpr *var = BPatch_variableExpr::makeVariableExpr(this, v, type);
175    mod->var_map[v] = var;
176    return var;
177 }
178
179
180
181 BPatch_function *BPatch_addressSpace::createBPFuncCB(AddressSpace *a, Dyninst::PatchAPI::PatchFunction *f)
182 {
183    BPatch_addressSpace *aS = (BPatch_addressSpace *)a->up_ptr();
184    assert(aS);
185    return aS->findOrCreateBPFunc(f, NULL);
186 }
187
188 BPatch_point *BPatch_addressSpace::createBPPointCB(AddressSpace *a,
189                                                    Dyninst::PatchAPI::PatchFunction *pf,
190                                                    Dyninst::PatchAPI::Point *p, int type)
191 {
192    func_instance *fi = static_cast<func_instance *>(pf);
193    instPoint *ip  = static_cast<instPoint *>(p);
194    BPatch_addressSpace *aS = (BPatch_addressSpace *)a->up_ptr();
195    assert(aS);
196
197    BPatch_module *bpmod = aS->getImage()->findOrCreateModule(fi->mod());
198    assert(bpmod);
199
200    BPatch_function *func = aS->findOrCreateBPFunc(fi, bpmod);
201    assert(func);
202
203    return aS->findOrCreateBPPoint(func, ip, (BPatch_procedureLocation) type);
204 }
205
206
207
208 /***************************************************************************
209  * Bpatch_snippetHandle
210  ***************************************************************************/
211
212 /*
213  * BPatchSnippetHandle::BPatchSnippetHandle
214  *
215  * Constructor for BPatchSnippetHandle.  Delete the snippet instance(s)
216  * associated with the BPatchSnippetHandle.
217  */
218 BPatchSnippetHandle::BPatchSnippetHandle(BPatch_addressSpace * addSpace) :
219    addSpace_(addSpace)
220 {
221 }
222
223 /*
224  * BPatchSnippetHandle::~BPatchSnippetHandle
225  *
226  * Destructor for BPatchSnippetHandle.  Delete the snippet instance(s)
227  * associated with the BPatchSnippetHandle.
228  */
229 BPatchSnippetHandle::~BPatchSnippetHandle()
230 {
231    // don't delete inst instances since they are might have been copied
232 }
233
234 BPatch_addressSpace *BPatchSnippetHandle::getAddressSpace()
235 {
236    return addSpace_;
237 }
238
239 BPatch_process *BPatchSnippetHandle::getProcess()
240 {
241    return dynamic_cast<BPatch_process *>(addSpace_);
242 }
243
244 BPatch_Vector<BPatch_thread *> &BPatchSnippetHandle::getCatchupThreads()
245 {
246    return catchup_threads;
247 }
248
249 // Return true if any sub-minitramp uses a trap? Other option
250 // is "if all"...
251 bool BPatchSnippetHandle::usesTrap() {
252     return false;
253 }
254
255 BPatch_function * BPatchSnippetHandle::getFunc()
256 {
257     if (!instances_.empty()) {
258        Dyninst::PatchAPI::PatchFunction *func = instances_.back()->point()->func();
259        BPatch_function *bpfunc = addSpace_->findOrCreateBPFunc(func,NULL);
260        return bpfunc;
261     }
262     return NULL;
263 }
264
265
266 BPatch_image * BPatch_addressSpace::getImage()
267 {
268    return image;
269 }
270
271
272 /*
273  * BPatch_addressSpace::deleteSnippet
274  *
275  * Deletes an instance of a snippet.
276  *
277  * handle       The handle returned by insertSnippet when the instance to
278  *              deleted was created.
279  */
280
281 bool BPatch_addressSpace::deleteSnippet(BPatchSnippetHandle *handle)
282 {
283    if (getTerminated()) return true;
284
285    if (handle == NULL) {
286        bperr("Request to delete NULL snippet handle, returning false\n");
287        return false;
288    }
289
290    if (handle->addSpace_ != this) {
291      bperr("Error: wrong address space in deleteSnippet\n");
292      return false;
293    }
294
295    mal_printf("deleting snippet handle from func at %lx, point at %lx of type %d\n",
296               (Address)handle->getFunc()->getBaseAddr(), 
297               handle->instances_.empty() ? 0 : handle->instances_[0]->point()->addr(),
298               handle->instances_.empty() ? -1 : handle->instances_[0]->point()->type());
299
300    // if this is a process, check to see if the instrumentation is
301    // executing on the call stack
302    instPoint *ip = static_cast<instPoint *>(handle->instances_[0]->point());
303
304    if ( handle->getProcess() && handle->instances_.size() > 0 &&
305        BPatch_normalMode !=
306         ip->func()->obj()->hybridMode())
307    {
308        if (handle->instances_.size() > 1) {
309            mal_printf("ERROR: Removing snippet that is installed in "
310                           "multiple miniTramps %s[%d]\n",FILE__,__LINE__);
311      }
312    }
313
314    // uninstrument and remove snippet handle from point datastructures
315    for (unsigned int i=0; i < handle->instances_.size(); i++)
316      {
317         uninstrument(handle->instances_[i]);
318         Dyninst::PatchAPI::Point *iPoint = handle->instances_[i]->point();
319         BPatch_point *bPoint = findOrCreateBPPoint(NULL, iPoint,
320                                                    BPatch_point::convertInstPointType_t(iPoint->type()));
321         assert(bPoint);
322         bPoint->removeSnippet(handle);
323      }
324
325    handle->instances_.clear();
326
327    if (pendingInsertions == NULL) {
328      // Trigger it now
329      bool tmp;
330      finalizeInsertionSet(false, &tmp);
331    }
332
333    //delete handle;
334    return true;
335 }
336
337 /*
338  * BPatch_addressSpace::replaceCode
339  *
340  * Replace a given instruction with a BPatch_snippet.
341  *
342  * point       Represents the instruction to be replaced
343  * snippet     The replacing snippet
344  */
345
346 bool BPatch_addressSpace::replaceCode(BPatch_point * /*point*/,
347                                          BPatch_snippet * /*snippet*/)
348 {
349    // Need to reevaluate how this code works. I don't think it should be
350    // point-based, though.
351
352    assert(0);
353    return false;
354 }
355
356 /*
357  * BPatch_addressSpace::replaceFunctionCall
358  *
359  * Replace a function call with a call to a different function.  Returns true
360  * upon success, false upon failure.
361  *
362  * point        The call site that is to be changed.
363  * newFunc      The function that the call site will now call.
364  */
365 bool BPatch_addressSpace::replaceFunctionCall(BPatch_point &point,
366       BPatch_function &newFunc)
367 {
368    char name[1024];
369    newFunc.getName(name, 1024);
370
371    // Can't make changes to code when mutations are not active.
372    if (!getMutationsActive())
373       return false;
374
375    assert(point.point && newFunc.lowlevel_func());
376
377   /* PatchAPI stuffs */
378    AddressSpace* addr_space = point.getAS();
379    DynModifyCallCommand* rep_call = DynModifyCallCommand::create(addr_space,
380       point.point->block(), newFunc.lowlevel_func(), point.point->func());
381   addr_space->patcher()->add(rep_call);
382   /* End of PatchAPI */
383
384    if (pendingInsertions == NULL) {
385      // Trigger it now
386      bool tmp;
387      finalizeInsertionSet(false, &tmp);
388    }
389    return true;
390 }
391
392 /*
393  * BPatch_addressSpace::removeFunctionCall
394  *
395  * Replace a function call with a NOOP.  Returns true upon success, false upon
396  * failure.
397  *
398  * point        The call site that is to be NOOPed out.
399  */
400 bool BPatch_addressSpace::removeFunctionCall(BPatch_point &point)
401 {
402    // Can't make changes to code when mutations are not active.
403    if (!getMutationsActive())
404       return false;
405
406    assert(point.point);
407
408   /* PatchAPI stuffs */
409    AddressSpace* addr_space = point.getAS();
410    DynRemoveCallCommand* remove_call = DynRemoveCallCommand::create(addr_space,
411       point.point->block(), point.point->func());
412   addr_space->patcher()->add(remove_call);
413   /* End of PatchAPI */
414
415    if (pendingInsertions == NULL) {
416      // Trigger it now
417      bool tmp;
418      finalizeInsertionSet(false, &tmp);
419    }
420
421    return true;
422 }
423
424
425 /*
426  * BPatch_addressSpace::replaceFunction
427  *
428  * Replace all calls to function OLDFUNC with calls to NEWFUNC.
429  * Returns true upon success, false upon failure.
430  *
431  * oldFunc      The function to replace
432  * newFunc      The replacement function
433  */
434 bool BPatch_addressSpace::replaceFunction(BPatch_function &oldFunc,
435       BPatch_function &newFunc)
436 {
437   assert(oldFunc.lowlevel_func() && newFunc.lowlevel_func());
438   if (!getMutationsActive())
439     return false;
440
441   // Self replacement is a nop
442   // We should just test direct equivalence here...
443   if (oldFunc.lowlevel_func() == newFunc.lowlevel_func()) {
444     return true;
445   }
446
447   /* PatchAPI stuffs */
448   AddressSpace* addr_space = oldFunc.lowlevel_func()->proc();
449   DynReplaceFuncCommand* rep_func = DynReplaceFuncCommand::create(addr_space,
450      oldFunc.lowlevel_func(), newFunc.lowlevel_func());
451   addr_space->patcher()->add(rep_func);
452   /* End of PatchAPI */
453
454   if (pendingInsertions == NULL) {
455     // Trigger it now
456     bool tmp;
457     finalizeInsertionSet(false, &tmp);
458   }
459   return true;
460 }
461
462 /*
463  * BPatch_addressSpace::revertReplaceFunction
464  *
465  * Undoes a replaceFunction operation
466  */
467 bool BPatch_addressSpace::revertReplaceFunction(BPatch_function &oldFunc)
468 {
469   assert(oldFunc.lowlevel_func());
470   if (!getMutationsActive())
471     return false;
472
473   func_instance *func = oldFunc.lowlevel_func();
474
475   func->proc()->revertReplacedFunction(func);
476
477   if (pendingInsertions == NULL) {
478     // Trigger it now
479     bool tmp;
480     finalizeInsertionSet(false, &tmp);
481   }
482   return true;
483 }
484
485 bool BPatch_addressSpace::wrapFunction(BPatch_function *original,
486                                           BPatch_function *wrapper,
487                                           Dyninst::SymtabAPI::Symbol *clone)
488 {
489    assert(original->lowlevel_func() && wrapper->lowlevel_func());
490    if (!getMutationsActive())
491       return false;
492
493    // Self replacement is a nop
494    // We should just test direct equivalence here...
495    if (original->lowlevel_func() == wrapper->lowlevel_func()) {
496       return true;
497    }
498
499    if (!original->lowlevel_func()->proc()->wrapFunction(original->lowlevel_func(), 
500                                                       wrapper->lowlevel_func(),
501                                                       clone))
502       return false;
503
504    if (pendingInsertions == NULL) {
505       // Trigger it now
506       bool tmp;
507       finalizeInsertionSet(false, &tmp);
508    }
509    return true;
510 }
511
512 bool BPatch_addressSpace::revertWrapFunction(BPatch_function *original)
513 {
514    assert(original->lowlevel_func());
515
516    func_instance *func = original->lowlevel_func();
517    assert(func);
518
519    func->proc()->revertWrapFunction(func);
520    
521    if (pendingInsertions == NULL) {
522       // Trigger it now
523       bool tmp;
524       finalizeInsertionSet(false, &tmp);
525    }
526    return true;
527 }
528
529
530 bool BPatch_addressSpace::getAddressRanges( const char * fileName,
531       unsigned int lineNo,
532       std::vector< std::pair< unsigned long, unsigned long > > & ranges )
533 {
534    unsigned int originalSize = ranges.size();
535    BPatch_Vector< BPatch_module * > * modules = image->getModules();
536
537    /* Iteratate over the modules, looking for addr in each. */
538    for ( unsigned int i = 0; i < modules->size(); i++ ) {
539       BPatch_module *m = (*modules)[i];
540       m->getAddressRanges(fileName, lineNo, ranges);
541    }
542
543    if ( ranges.size() != originalSize ) { return true; }
544
545    return false;
546 } /* end getAddressRanges() */
547
548 bool BPatch_addressSpace::getSourceLines( unsigned long addr,
549       BPatch_Vector< BPatch_statement > & lines )
550 {
551    return image->getSourceLines(addr, lines);
552 } /* end getLineAndFile() */
553
554
555 /*
556  * BPatch_process::malloc
557  *
558  * Allocate memory in the thread's address space.
559  *
560  * n    The number of bytes to allocate.
561  *
562  * Returns:
563  *      A pointer to a BPatch_variableExpr representing the memory.
564  *
565  * If otherwise unspecified when binary rewriting, then the allocation
566  * happens in the original object.
567  */
568
569 BPatch_variableExpr *BPatch_addressSpace::malloc(int n, std::string name)
570 {
571    std::vector<AddressSpace *> as;
572    assert(BPatch::bpatch != NULL);
573    getAS(as);
574    assert(as.size());
575    void *ptr = (void *) as[0]->inferiorMalloc(n, dataHeap);
576    if (!ptr) return NULL;
577    if(name.empty()){
578       std::stringstream namestr;
579       namestr << "dyn_malloc_0x" << std::hex << ptr << "_" << n << "_bytes";
580       name = namestr.str();
581    }
582    BPatch_type *type = BPatch::bpatch->createScalar(name.c_str(), n);
583
584    return BPatch_variableExpr::makeVariableExpr(this, as[0], name, ptr,
585                                                 type);
586 }
587
588
589 /*
590  * BPatch_process::malloc
591  *
592  * Allocate memory in the thread's address space for a variable of the given
593  * type.
594  *
595  * type         The type of variable for which to allocate space.
596  *
597  * Returns:
598  *      A pointer to a BPatch_variableExpr representing the memory.
599  *
600  * XXX Should return NULL on failure, but the function which it calls,
601  *     inferiorMalloc, calls exit rather than returning an error, so this
602  *     is not currently possible.
603  */
604
605 BPatch_variableExpr *BPatch_addressSpace::malloc(const BPatch_type &type, std::string name)
606 {
607    std::vector<AddressSpace *> as;
608    assert(BPatch::bpatch != NULL);
609    getAS(as);
610    assert(as.size());
611    BPatch_type &t = const_cast<BPatch_type &>(type);
612    cerr << "Allocating " << t.getSize() << endl;
613    void *mem = (void *) as[0]->inferiorMalloc(t.getSize(), dataHeap);
614    cerr << "Returning " << hex << mem << dec << endl;
615    if (!mem) return NULL;
616    if(name.empty()){
617       std::stringstream namestr;
618       namestr << "dyn_malloc_0x" << std::hex << mem << "_" << type.getName();
619       name = namestr.str();
620    }
621    BPatch_variableExpr *varExpr = BPatch_variableExpr::makeVariableExpr(this, as[0], name, mem, &t);
622    return varExpr;
623 }
624
625 /*
626  * BPatch_process::free
627  *
628  * Free memory that was allocated with BPatch_process::malloc.
629  *
630  * ptr          A BPatch_variableExpr representing the memory to free.
631  */
632
633 bool BPatch_addressSpace::free(BPatch_variableExpr &ptr)
634 {
635   if(ptr.intvar)
636   {
637     // kill the symbols
638
639   }
640
641    ptr.getAS()->inferiorFree((Address)ptr.getBaseAddr());
642    return true;
643 }
644
645 BPatch_variableExpr *BPatch_addressSpace::createVariable(std::string name,
646                                                             Dyninst::Address addr,
647                                                             BPatch_type *type) {
648     assert(BPatch::bpatch != NULL);
649     std::vector<AddressSpace *> as;
650     getAS(as);
651     assert(as.size());
652
653 //dynC added feature
654     if(strstr(name.c_str(), "dynC") == name.c_str()){
655        void *mem = (void *) as[0]->inferiorMalloc(type->getSize(), dataHeap);
656        if (!mem) return NULL;
657        BPatch_variableExpr *varExpr = BPatch_variableExpr::makeVariableExpr(this, as[0], name, mem, type);
658        BPatch_module *mod = image->findOrCreateModule(varExpr->intvar->mod());
659        assert(mod);
660        mod->var_map[varExpr->intvar] = varExpr;
661        return varExpr;
662     }
663
664     BPatch_variableExpr *varExpr = BPatch_variableExpr::makeVariableExpr(this,
665                                                  as[0],
666                                                  name,
667                                                  (void *)addr,
668                                                  type);
669
670     return varExpr;
671 }
672
673 /*
674  * BPatch_addressSpace::findFunctionByAddr
675  *
676  * Returns the function that contains the specified address, or NULL if the
677  * address is not within a function.
678  *
679  * addr         The address to use for the lookup.
680  */
681 BPatch_function *BPatch_addressSpace::findFunctionByAddr(void *addr)
682 {
683    std::vector<AddressSpace *> as;
684
685    getAS(as);
686    assert(as.size());
687    std::set<func_instance *> funcs;
688    if (!as[0]->findFuncsByAddr((Address) addr, funcs)) {
689       // if it's a mapped_object that has yet to be analyzed,
690       // trigger analysis and re-invoke this function
691        mapped_object *obj = as[0]->findObject((Address) addr);
692        if (obj &&
693            !obj->isAnalyzed()) {
694          obj->analyze();
695          return findFunctionByAddr(addr);
696       }
697       return NULL;
698    }
699    if (funcs.empty()) return NULL;
700
701    if (funcs.size() > 1) {
702        bpwarn("Warning: deprecated function findFunctionByAddr found "
703               "multiple functions sharing address 0x%lx, picking one at "
704               "random.  Use findFunctionByEntry or findFunctionsByAddr\n",
705               addr);
706    }
707
708    return findOrCreateBPFunc((*(funcs.begin())), NULL);
709 }
710
711 /*
712  *  BPatch_addressSpace::findFunctionByEntry
713  *
714  *  Returns the function starting at the given address, or NULL if the
715  *  address is not within a function.
716  *
717  *  entry       The address to use for the lookup.
718  */
719 BPatch_function *BPatch_addressSpace::findFunctionByEntry(Address entry)
720 {
721     vector<BPatch_function*> funcs;
722     findFunctionsByAddr(entry, funcs);
723     vector<BPatch_function*>::iterator fit;
724     for (fit = funcs.begin(); fit != funcs.end(); fit++) {
725         if (entry == (Address)(*fit)->getBaseAddr()) {
726             return *fit;
727         }
728     }
729     return NULL;
730 }
731
732 bool BPatch_addressSpace::findFuncsByRange(Address startAddr,
733                                            Address endAddr,
734                                            std::set<BPatch_function*> &bpFuncs)
735 {
736     std::vector<AddressSpace *> as;
737     getAS(as);
738     assert(as.size());
739
740     // find the first code range in the region
741     mapped_object* mobj = as[0]->findObject(startAddr);
742     assert(mobj);
743     set<func_instance*> intFuncs;
744     mobj->findFuncsByRange(startAddr,endAddr,intFuncs);
745     set<func_instance*>::iterator fIter = intFuncs.begin();
746     for (; fIter != intFuncs.end(); fIter++) {
747         BPatch_function * bpfunc = findOrCreateBPFunc(*fIter,NULL);
748         bpFuncs.insert(bpfunc);
749     }
750     return 0 != bpFuncs.size();
751 }
752
753
754 /*
755  * BPatch_addressSpace::findFunctionsByAddr
756  *
757  * Returns the functions that contain the specified address, or NULL if the
758  * address is not within a function. (there could be multiple functions
759  * because of the possibility of shared code)
760  *
761  * addr         The address to use for the lookup.
762  * returns false if there were no functions that matched the address
763  */
764 bool BPatch_addressSpace::findFunctionsByAddr(Address addr, std::vector<BPatch_function*> &funcs)
765 {
766     std::vector<AddressSpace *> as;
767     getAS(as);
768     assert(as.size());
769
770     // grab the funcs, return false if there aren't any
771     std::set<func_instance*> intfuncs;
772     if (!as[0]->findFuncsByAddr( addr, intfuncs )) {
773         return false;
774     }
775     // convert to BPatch_functions
776     for (std::set<func_instance *>::iterator fiter=intfuncs.begin();
777          fiter != intfuncs.end(); fiter++)
778     {
779         funcs.push_back(findOrCreateBPFunc(*fiter, NULL));
780     }
781     return 0 < funcs.size();
782 }
783
784
785 /*
786  * BPatch_addressSpace::findModuleByAddr
787  *
788  * Returns the module that contains the specified address, or NULL if the
789  * address is not within a module.  Does NOT trigger parsing
790  *
791  * addr         The address to use for the lookup.
792  */
793 BPatch_module *BPatch_addressSpace::findModuleByAddr(Address addr)
794 {
795    std::vector<AddressSpace *> as;
796    getAS(as);
797    assert(as.size());
798
799    mapped_object *obj = as[0]->findObject(addr);
800    if ( ! obj )
801        return NULL;
802
803    const pdvector<mapped_module*> mods = obj->getModules();
804    if (mods.size()) {
805        return getImage()->findOrCreateModule(mods[0]);
806    }
807    return NULL;
808 }
809
810
811 /*
812  * BPatch_addressSpace::insertSnippet
813  *
814  * Insert a code snippet at a given instrumentation point.  Upon success,
815  * returns a handle to the created instance of the snippet, which can be used
816  * to delete it.  Otherwise returns NULL.
817  *
818  * expr         The snippet to insert.
819  * point        The point at which to insert it.
820  */
821
822 BPatchSnippetHandle *BPatch_addressSpace::insertSnippet(const BPatch_snippet &expr,
823       BPatch_point &point,
824       BPatch_snippetOrder order)
825 {
826    BPatch_callWhen when;
827    if (point.getPointType() == BPatch_exit)
828       when = BPatch_callAfter;
829    else
830       when = BPatch_callBefore;
831
832    return insertSnippet(expr, point, when, order);
833 }
834
835 /*
836  * BPatch_addressSpace::insertSnippet
837  *
838  * Insert a code snippet at a given instrumentation point.  Upon succes,
839  * returns a handle to the created instance of the snippet, which can be used
840  * to delete it.  Otherwise returns NULL.
841  *
842  * expr         The snippet to insert.
843  * point        The point at which to insert it.
844  */
845
846 // This handles conversion without requiring inst.h in a header file...
847 extern bool BPatchToInternalArgs(BPatch_point *point,
848       BPatch_callWhen when,
849       BPatch_snippetOrder order,
850       callWhen &ipWhen,
851       callOrder &ipOrder);
852
853
854 BPatchSnippetHandle *BPatch_addressSpace::insertSnippet(const BPatch_snippet &expr,
855       BPatch_point &point,
856       BPatch_callWhen when,
857       BPatch_snippetOrder order)
858 {
859    BPatch_Vector<BPatch_point *> points;
860    points.push_back(&point);
861    return insertSnippet(expr,
862          points,
863          when,
864          order);
865 }
866
867 extern int dyn_debug_ast;
868
869 /*
870  * BPatch_addressSpace::insertSnippet
871  *
872  * Insert a code snippet at each of a list of instrumentation points.  Upon
873  * success, Returns a handle to the created instances of the snippet, which
874  * can be used to delete them (as a unit).  Otherwise returns NULL.
875  *
876  * expr         The snippet to insert.
877  * points       The list of points at which to insert it.
878  */
879
880 // A lot duplicated from the single-point version. This is unfortunate.
881 BPatchSnippetHandle *BPatch_addressSpace::insertSnippet(const BPatch_snippet &expr,
882                                                                     const BPatch_Vector<BPatch_point *> &points,
883                                                                     BPatch_callWhen when,
884                                                                     BPatch_snippetOrder order)
885 {
886   BPatchSnippetHandle *retHandle = new BPatchSnippetHandle(this);
887
888   if (dyn_debug_inst) {
889       BPatch_function *f;
890       for (unsigned i=0; i<points.size(); i++) {
891          f = points[i]->getFunction();
892          const char *sname = f->func->prettyName().c_str();
893          inst_printf("[%s:%u] - %d. Insert instrumentation at function %s, "
894                "address %p, when %d, order %d\n",
895                FILE__, __LINE__, i,
896                sname, points[i]->getAddress(), (int) when, (int) order);
897
898       }
899   }
900
901   if (BPatch::bpatch->isTypeChecked()) {
902       if (expr.ast_wrapper->checkType() == BPatch::bpatch->type_Error) {
903         fprintf(stderr, "[%s:%u] - Type error inserting instrumentation\n",
904                 FILE__, __LINE__);
905         //expr.ast_wrapper->debugPrint();
906          return NULL;
907       }
908    }
909
910    if (!points.size()) {
911       inst_printf("%s[%d]:  request to insert snippet at zero points!\n", FILE__, __LINE__);
912       return NULL;
913    }
914
915    for (unsigned i = 0; i < points.size(); i++) {
916       BPatch_point *bppoint = points[i];
917
918       if (bppoint->addSpace == NULL) {
919          fprintf(stderr, "Error: attempt to use point with no process info\n");
920          continue;
921       }
922
923       if (dynamic_cast<BPatch_addressSpace *>(bppoint->addSpace) != this) {
924          fprintf(stderr, "Error: attempt to use point specific to a different process\n");
925          continue;
926       }
927
928       callWhen ipWhen;
929       callOrder ipOrder;
930
931       if (!BPatchToInternalArgs(bppoint, when, order, ipWhen, ipOrder)) {
932         fprintf(stderr, "[%s:%u] - BPatchToInternalArgs failed for point %d\n",
933                FILE__, __LINE__, i);
934          return retHandle;
935       }
936
937       /* PatchAPI stuffs */
938       instPoint *ipoint = static_cast<instPoint *>(bppoint->getPoint(when));
939       Dyninst::PatchAPI::InstancePtr instance = (ipOrder == orderFirstAtPoint) ?
940          ipoint->pushFront(expr.ast_wrapper) :
941          ipoint->pushBack(expr.ast_wrapper);
942       /* End of PatchAPI stuffs */
943       if (instance) {
944          if (BPatch::bpatch->isTrampRecursive()) {
945             instance->disableRecursiveGuard();
946          }
947          retHandle->addInstance(instance);
948          bppoint->recordSnippet(when, order, retHandle);
949       }
950    }
951    if (pendingInsertions == NULL) {
952      // There's no insertion set, instrument now
953      bool tmp;
954      if (!finalizeInsertionSet(false, &tmp)) {
955         return NULL;
956      }
957    }   
958
959    return retHandle;
960 }
961
962
963 /*
964  * BPatch_addressSpace::insertSnippet
965  *
966  * Insert a code snippet at each of a list of instrumentation points.  Upon
967  * success, Returns a handle to the created instances of the snippet, which
968  * can be used to delete them (as a unit).  Otherwise returns NULL.
969  *
970  * expr         The snippet to insert.
971  * points       The list of points at which to insert it.
972  */
973
974 BPatchSnippetHandle *BPatch_addressSpace::insertSnippet(
975       const BPatch_snippet &expr,
976       const BPatch_Vector<BPatch_point *> &points,
977       BPatch_snippetOrder order)
978 {
979    return insertSnippet(expr,
980          points,
981          BPatch_callUnset,
982          order);
983 }
984
985 /*
986  * BPatch_addressSpace::isStaticExecutable
987  *
988  * Returns true if the underlying image represents a statically-linked executable, false otherwise.
989  */
990 bool BPatch_addressSpace::isStaticExecutable() {
991    std::vector<AddressSpace *> as;
992    getAS(as);
993
994    if( !as.size() ) return false;
995
996    AddressSpace *aout = as[0];
997    return aout->getAOut()->isStaticExec();
998 }
999
1000 #include "registerSpace.h"
1001
1002 #if defined(cap_registers)
1003 bool BPatch_addressSpace::getRegisters(std::vector<BPatch_register> &regs) {
1004    if (registers_.size()) {
1005        regs = registers_;
1006        return true;
1007    }
1008
1009    std::vector<AddressSpace *> as;
1010
1011    getAS(as);
1012    assert(as.size());
1013
1014    registerSpace *rs = registerSpace::getRegisterSpace(as[0]);
1015
1016    for (unsigned i = 0; i < rs->realRegs().size(); i++) {
1017        // Let's do just GPRs for now
1018        registerSlot *regslot = rs->realRegs()[i];
1019        registers_.push_back(BPatch_register(regslot->name, regslot->number));
1020    }
1021
1022 // Temporary override: also return EFLAGS though it's certainly not a 
1023 #if defined(arch_x86) || defined(arch_x86_64)
1024    for (unsigned i = 0; i < rs->SPRs().size(); ++i) {
1025       if (rs->SPRs()[i]->name == "eflags") {
1026          registers_.push_back(BPatch_register(rs->SPRs()[i]->name, 
1027                                               rs->SPRs()[i]->number));
1028       }
1029    }
1030 #endif
1031
1032    regs = registers_;
1033    return true;
1034 }
1035 #else
1036 bool BPatch_addressSpace::getRegisters(std::vector<BPatch_register> &) {
1037     // Empty vector since we're not supporting register objects on
1038     // these platforms (yet)
1039    return false;
1040 }
1041 #endif
1042
1043 #if defined(cap_registers)
1044 bool BPatch_addressSpace::createRegister_NP(std::string regName,
1045                                                BPatch_register &reg) {
1046     // Build the register list.
1047     std::vector<BPatch_register> dontcare;
1048     getRegisters(dontcare);
1049
1050     for (unsigned i = 0; i < registers_.size(); i++) {
1051         if (registers_[i].name() == regName) {
1052             reg = registers_[i];
1053             return true;
1054         }
1055     }
1056     return false;
1057 }
1058 #else
1059 bool BPatch_addressSpace::createRegister_NP(std::string,
1060                                                BPatch_register &)
1061 {
1062    return false;
1063 }
1064 #endif
1065
1066 void BPatch_addressSpace::allowTraps(bool allowtraps)
1067 {
1068    std::vector<AddressSpace *> as;
1069    getAS(as);
1070
1071    for (std::vector<AddressSpace *>::iterator i = as.begin(); i != as.end(); i++)
1072    {
1073       (*i)->setUseTraps(allowtraps);
1074    }
1075 }
1076
1077 BPatch_variableExpr *BPatch_addressSpace::createVariable(
1078                         Dyninst::Address at_addr,
1079                         BPatch_type *type, std::string var_name,
1080                         BPatch_module *in_module)
1081 {
1082    BPatch_binaryEdit *binEdit = dynamic_cast<BPatch_binaryEdit *>(this);
1083    if (binEdit && !in_module) {
1084       //Address alone isn't unique when binary rewriting
1085       return NULL;
1086    }
1087    if (!type) {
1088       //Required for size information.
1089       return NULL;
1090    }
1091    AddressSpace *ll_addressSpace = NULL;
1092
1093    std::vector<AddressSpace *> as;
1094    getAS(as);
1095    if (binEdit) {
1096       std::vector<AddressSpace *>::iterator as_i;
1097       for (as_i = as.begin(); as_i != as.end(); as_i++)
1098       {
1099          BinaryEdit *b = dynamic_cast<BinaryEdit *>(*as_i);
1100          assert(b);
1101          if (in_module->mod->obj() == b->getMappedObject()) {
1102             ll_addressSpace = *as_i;
1103             break;
1104          }
1105       }
1106    }
1107    else {
1108       assert(as.size() == 1);
1109       ll_addressSpace = as[0];
1110    }
1111
1112    if (!ll_addressSpace) {
1113       //in_module doesn't belong to 'this'
1114       return NULL;
1115    }
1116
1117    if (!var_name.size()) {
1118       std::stringstream namestream;
1119       namestream << "dyninst_var_" << std::hex << at_addr;
1120       var_name = namestream.str();
1121    }
1122
1123    return BPatch_variableExpr::makeVariableExpr(this, ll_addressSpace, var_name,
1124                                                 (void *) at_addr, type);
1125 }
1126
1127 Dyninst::PatchAPI::PatchMgrPtr Dyninst::PatchAPI::convert(const BPatch_addressSpace *a) {
1128    const BPatch_binaryEdit *edit = dynamic_cast<const BPatch_binaryEdit *>(a);
1129    if (edit) {
1130       return edit->lowlevel_edit()->mgr();
1131    }
1132    else {
1133       const BPatch_process *proc = dynamic_cast<const BPatch_process *>(a);
1134       return proc->lowlevel_process()->mgr();
1135    }
1136 }
1137