Code refactoring adds parent class to BPatch_process
[dyninst.git] / dyninstAPI / src / addressSpace.h
1 /*
2  * Copyright (c) 1996-2004 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 // $Id: addressSpace.h,v 1.4 2007/09/23 21:08:54 rutar Exp $
43
44 #ifndef ADDRESS_SPACE_H
45 #define ADDRESS_SPACE_H
46
47 #include "infHeap.h"
48 #include "codeRange.h"
49 #include "InstructionSource.h"
50 #include "ast.h"
51 #include "symtabAPI/h/Symtab.h"
52
53 class codeRange;
54 class multiTramp;
55 class replacedFunctionCall;
56 class functionReplacement;
57
58 class int_function;
59 class int_variable;
60 class mapped_module;
61 class mapped_object;
62 class instPoint;
63
64 class BPatch_process;
65 class BPatch_function;
66 class BPatch_point;
67
68 class Emitter;
69 class generatedCodeObject;
70
71 using namespace Dyninst;
72 using namespace SymtabAPI;
73
74 class int_function;
75
76
77 class Dyn_Symbol;
78 class BinaryEdit;
79
80
81 // This file serves to define an "address space", a set of routines that 
82 // code generation and instrumentation rely on to perform their duties. 
83 // This was derived from the process class and serves as a parent to that
84 // class and the static_space class for the rewriter. 
85
86 // The methods in this class were determined by what the code currently
87 // uses, not a particular design. As such, I expect this to change wildly
88 // by the time the refactoring is complete. 
89 //
90 // bernat, 5SEP07
91
92 // Note: this is a pure virtual class; it serves as an interface
93 // specification.
94
95 class AddressSpace : public InstructionSource {
96  public:
97     
98     // Down-conversion functions
99     process *proc();
100     BinaryEdit *edit();
101
102     // Read/write
103
104     // We have read/write for both "text" and "data". This comes in handy,
105     // somewhere, I'm sure
106     virtual bool readDataSpace(const void *inOther, 
107                                u_int amount, 
108                                void *inSelf, 
109                                bool showError) = 0;
110     virtual bool readTextSpace(const void *inOther, 
111                                u_int amount, 
112                                const void *inSelf) = 0;
113     
114
115     virtual bool writeDataSpace(void *inOther,
116                                 u_int amount,
117                                 const void *inSelf) = 0;
118     virtual bool writeTextSpace(void *inOther,
119                                 u_int amount,
120                                 const void *inSelf) = 0;
121
122     // Memory allocation
123     // We don't specify how it should be done, only that it is. The model is
124     // that you ask for an allocation "near" a point, where "near" has an
125     // internal, platform-specific definition. The allocation mechanism does its
126     // best to give you what you want, but there are no promises - check the
127     // address of the returned buffer to be sure.
128
129     virtual Address inferiorMalloc(unsigned size, inferiorHeapType type=anyHeap,
130                                    Address near = 0, bool *err = NULL) = 0;
131     void inferiorFree(Address item);
132     // And a "constrain" call to free unused memory. This is useful because our
133     // instrumentation is incredibly wasteful.
134     virtual bool inferiorRealloc(Address item, unsigned newSize);
135
136     bool isInferiorAllocated(Address block);
137
138     // Get the pointer size of the app we're modifying
139     virtual unsigned getAddressWidth() const = 0;
140
141     // We need a mechanism to track what exists at particular addresses in the
142     // address space - both for lookup and to ensure that there are no collisions.
143     // We have a multitude of ways to "muck with" the application (function replacement,
144     // instrumentation, function relocation, ...) and they can all stomp on each
145     // other. 
146
147     void addOrigRange(codeRange *range);
148     void addModifiedRange(codeRange *range);
149
150     void removeOrigRange(codeRange *range);
151     void removeModifiedRange(codeRange *range);
152
153     codeRange *findOrigByAddr(Address addr);
154     codeRange *findModByAddr(Address addr);
155
156     virtual void *getPtrToInstruction(Address) const;
157     virtual bool isValidAddress(const Address &) const;
158
159     // Trap address to base tramp address (for trap instrumentation)
160     dictionary_hash<Address, Address> trampTrapMapping;
161     
162     // Should return iterators
163     bool getOrigRanges(pdvector<codeRange *> &);
164     bool getModifiedRanges(pdvector<codeRange *> &);
165
166     // Multitramp convenience functions
167     multiTramp *findMultiTrampByAddr(Address addr);
168     multiTramp *findMultiTrampById(unsigned int id);
169     void addMultiTramp(multiTramp *multi);
170     void removeMultiTramp(multiTramp *multi);
171
172     // Function replacement (or relocated, actually) convenience functions
173     functionReplacement *findFuncReplacement(Address addr);
174     void addFuncReplacement(functionReplacement *funcrep);
175     void removeFuncReplacement(functionReplacement *funcrep);
176
177     // Function call replacement convenience functions
178     replacedFunctionCall *findReplacedCall(Address addr);
179     void addReplacedCall(replacedFunctionCall *rep);
180     void removeReplacedCall(replacedFunctionCall *rep);
181
182     //////////////////////////////////////////////////////////////
183     // Function/variable lookup code
184     // Turns out that instrumentation needs this... so the 
185     // AddressSpace keeps growing. 
186     //////////////////////////////////////////////////////////////
187
188     // findFuncByName: returns function associated with "func_name"
189     // This routine checks both the a.out image and any shared object images 
190     // for this function
191     //int_function *findFuncByName(const pdstring &func_name);
192     
193     bool findFuncsByAll(const pdstring &funcname,
194                         pdvector<int_function *> &res,
195                         const pdstring &libname = "");
196     
197     // Specific versions...
198     bool findFuncsByPretty(const pdstring &funcname,
199                            pdvector<int_function *> &res,
200                            const pdstring &libname = "");
201     bool findFuncsByMangled(const pdstring &funcname, 
202                             pdvector<int_function *> &res,
203                             const pdstring &libname = "");
204     
205     bool findVarsByAll(const pdstring &varname,
206                        pdvector<int_variable *> &res,
207                        const pdstring &libname = "");
208     
209     // And we often internally want to wrap the above to return one
210     // and only one func...
211     int_function *findOnlyOneFunction(const std::string &name,
212                                       const std::string &libname = "");
213
214
215     // This will find the named symbol in the image or in a shared object
216     // Necessary since some things don't show up as a function or variable.
217     //    bool getSymbolInfo( const pdstring &name, Dyn_Symbol &ret );
218     bool getSymbolInfo( const pdstring &name, Dyninst::SymtabAPI::Symbol &ret );
219
220     // getAllFunctions: returns a vector of all functions defined in the
221     // a.out and in the shared objects
222     void getAllFunctions(pdvector<int_function *> &);
223     
224     // Find the code sequence containing an address
225     // Note: fix the name....
226     int_function *findFuncByAddr(Address addr);
227     int_basicBlock *findBasicBlockByAddr(Address addr);
228     
229     // And a lookup by "internal" function to find clones during fork...
230     int_function *findFuncByInternalFunc(image_func *ifunc);
231     
232     //findJumpTargetFuncByAddr Acts like findFunc, but if it fails,
233     // checks if 'addr' is a jump to a function.
234     int_function *findJumpTargetFuncByAddr(Address addr);
235     
236     // findModule: returns the module associated with "mod_name" 
237     // this routine checks both the a.out image and any shared object 
238     // images for this module
239     // if check_excluded is true it checks to see if the module is excluded
240     // and if it is it returns 0.  If check_excluded is false it doesn't check
241     //  if substring_match is true, the first module whose name contains
242     //  the provided string is returned.
243     // Wildcard: handles "*" and "?"
244     mapped_module *findModule(const pdstring &mod_name, bool wildcard = false);
245     // And the same for objects
246     // Wildcard: handles "*" and "?"
247     mapped_object *findObject(const pdstring &obj_name, bool wildcard = false);
248     mapped_object *findObject(Address addr);
249
250     mapped_object *getAOut() { assert(mapped_objects.size()); return mapped_objects[0];}
251     
252     // getAllModules: returns a vector of all modules defined in the
253     // a.out and in the shared objects
254     void getAllModules(pdvector<mapped_module *> &);
255
256     // return the list of dynamically linked libs
257     const pdvector<mapped_object *> &mappedObjects() { return mapped_objects;  } 
258     
259     // If true is passed for ignore_if_mt_not_set, then an error won't be
260     // initiated if we're unable to determine if the program is multi-threaded.
261     // We are unable to determine this if the daemon hasn't yet figured out
262     // what libraries are linked against the application.  Currently, we
263     // identify an application as being multi-threaded if it is linked against
264     // a thread library (eg. libpthreads.a on AIX).  There are cases where we
265     // are querying whether the app is multi-threaded, but it can't be
266     // determined yet but it also isn't necessary to know.
267     virtual bool multithread_capable(bool ignore_if_mt_not_set = false) = 0;
268     
269     // Do we have the RT-side multithread functions available
270     virtual bool multithread_ready(bool ignore_if_mt_not_set = false) = 0;
271
272     //////////////////////////////////////////////////////
273     // Process-level instrumentation (?)
274     /////////////////////////////////////////////////////
275
276     // instPoint isn't const; it may get an updated list of
277     // instances since we generate them lazily.
278     // Shouldn't this be an instPoint member function?
279     bool replaceFunctionCall(instPoint *point,const int_function *newFunc);
280     
281     // And this....
282     bool getDynamicCallSiteArgs(instPoint *callSite, 
283                                 pdvector<AstNodePtr> &args);
284
285     // Default to "nope"
286     virtual bool hasBeenBound(const relocationEntry &, 
287                               int_function *&, 
288                               Address) { return false; }
289     
290     // Trampoline guard get/set functions
291     Address trampGuardBase(void) { return trampGuardBase_; }
292     AstNodePtr trampGuardAST(void);
293
294     // Get the current code generator (or emitter)
295     Emitter *getEmitter();
296
297     // Should be easy if the process isn't _executing_ where
298     // we're deleting...
299     virtual void deleteGeneratedCode(generatedCodeObject *del);
300
301     //////////////////////////////////////////////////////
302     // BPatch-level stuff
303     //////////////////////////////////////////////////////
304     // Callbacks for higher level code (like BPatch) to learn about new 
305     //  functions and InstPoints.
306  private:
307     BPatch_function *(*new_func_cb)(AddressSpace *a, int_function *f);
308     BPatch_point *(*new_instp_cb)(AddressSpace *a, int_function *f, instPoint *ip, 
309                                   int type);
310  public:
311     //Trigger the callbacks from a lower level
312     BPatch_function *newFunctionCB(int_function *f) 
313         { assert(new_func_cb); return new_func_cb(this, f); }
314     BPatch_point *newInstPointCB(int_function *f, instPoint *pt, int type)
315         { assert(new_instp_cb); return new_instp_cb(this, f, pt, type); }
316     
317     //Register callbacks from the higher level
318     void registerFunctionCallback(BPatch_function *(*f)(AddressSpace *p, 
319                                                         int_function *f))
320         { new_func_cb = f; };
321     void registerInstPointCallback(BPatch_point *(*f)(AddressSpace *p, int_function *f,
322                                                       instPoint *ip, int type))
323         { new_instp_cb = f; }
324     
325     
326     //Anonymous up pointer to the containing process.  This is BPatch_process
327     // in Dyninst.  Currently stored as an void pointer in case we do
328     // anything with this during the library split.
329     void *up_ptr() { return up_ptr_; }
330     void set_up_ptr(void *ptr) { up_ptr_ = ptr; }
331     
332     //////////////////////////////////////////////////////
333     // Internal and cleanup 
334     //////////////////////////////////////////////////////
335
336     // Clear things out (e.g., deleteProcess)
337     void deleteAddressSpace();
338     // Fork psuedo-constructor
339     void copyAddressSpace(process *parent);
340
341     // Aaand constructor/destructor
342     AddressSpace();
343     virtual ~AddressSpace();
344
345
346     //////////////////////////////////////////////////////
347     // Yuck
348     //////////////////////////////////////////////////////
349     Address getObservedCostAddr() const { return costAddr_; }
350     void updateObservedCostAddr(Address addr) { costAddr_ = addr;}
351
352
353  protected:
354
355     // inferior malloc support functions
356     void inferiorFreeCompact();
357     int findFreeIndex(unsigned size, int type, Address lo, Address hi);
358     void addHeap(heapItem *h);
359     void initializeHeap();
360     
361     // Centralization of certain inferiorMalloc operations
362     Address inferiorMallocInternal(unsigned size, Address lo, Address hi, 
363                                    inferiorHeapType type);
364     void inferiorMallocAlign(unsigned &size);
365
366     bool heapInitialized_;
367     inferiorHeap heap_;
368
369     // Text sections (including added - instrumentation)
370     codeRangeTree textRanges_;
371     // Data sections
372     codeRangeTree dataRanges_;
373     // And address-space-wide patches that we've dropped in
374     codeRangeTree modifiedRanges_;
375
376     // We label multiTramps by ID
377     dictionary_hash<int, multiTramp *> multiTrampsById_;
378
379     // Loaded mapped objects (may be just 1)
380     pdvector<mapped_object *> mapped_objects;
381
382     Address trampGuardBase_; // Tramp recursion index mapping
383     AstNodePtr trampGuardAST_;
384
385     void *up_ptr_;
386
387     Address costAddr_;
388
389     
390 };
391
392 extern int heapItemCmpByAddr(const heapItem **A, const heapItem **B);
393
394 #endif // ADDRESS_SPACE_H