Move debug information parsing to SymtabAPI - - - - - - - - - - - - - -
[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.3 2007/09/19 21:54:36 giri 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 class BinaryEdit;
77
78 // This file serves to define an "address space", a set of routines that 
79 // code generation and instrumentation rely on to perform their duties. 
80 // This was derived from the process class and serves as a parent to that
81 // class and the static_space class for the rewriter. 
82
83 // The methods in this class were determined by what the code currently
84 // uses, not a particular design. As such, I expect this to change wildly
85 // by the time the refactoring is complete. 
86 //
87 // bernat, 5SEP07
88
89 // Note: this is a pure virtual class; it serves as an interface
90 // specification.
91
92 class AddressSpace : public InstructionSource {
93  public:
94     
95     // Down-conversion functions
96     process *proc();
97     BinaryEdit *edit();
98
99     // Read/write
100
101     // We have read/write for both "text" and "data". This comes in handy,
102     // somewhere, I'm sure
103     virtual bool readDataSpace(const void *inOther, 
104                                u_int amount, 
105                                void *inSelf, 
106                                bool showError) = 0;
107     virtual bool readTextSpace(const void *inOther, 
108                                u_int amount, 
109                                const void *inSelf) = 0;
110     
111
112     virtual bool writeDataSpace(void *inOther,
113                                 u_int amount,
114                                 const void *inSelf) = 0;
115     virtual bool writeTextSpace(void *inOther,
116                                 u_int amount,
117                                 const void *inSelf) = 0;
118
119     // Memory allocation
120     // We don't specify how it should be done, only that it is. The model is
121     // that you ask for an allocation "near" a point, where "near" has an
122     // internal, platform-specific definition. The allocation mechanism does its
123     // best to give you what you want, but there are no promises - check the
124     // address of the returned buffer to be sure.
125
126     virtual Address inferiorMalloc(unsigned size, inferiorHeapType type=anyHeap,
127                                    Address near = 0, bool *err = NULL) = 0;
128     void inferiorFree(Address item);
129     // And a "constrain" call to free unused memory. This is useful because our
130     // instrumentation is incredibly wasteful.
131     virtual bool inferiorRealloc(Address item, unsigned newSize);
132
133     bool isInferiorAllocated(Address block);
134
135     // Get the pointer size of the app we're modifying
136     virtual unsigned getAddressWidth() const = 0;
137
138     // We need a mechanism to track what exists at particular addresses in the
139     // address space - both for lookup and to ensure that there are no collisions.
140     // We have a multitude of ways to "muck with" the application (function replacement,
141     // instrumentation, function relocation, ...) and they can all stomp on each
142     // other. 
143
144     void addOrigRange(codeRange *range);
145     void addModifiedRange(codeRange *range);
146
147     void removeOrigRange(codeRange *range);
148     void removeModifiedRange(codeRange *range);
149
150     codeRange *findOrigByAddr(Address addr);
151     codeRange *findModByAddr(Address addr);
152
153     virtual void *getPtrToInstruction(Address) const;
154     virtual bool isValidAddress(const Address &) const;
155
156     // Trap address to base tramp address (for trap instrumentation)
157     dictionary_hash<Address, Address> trampTrapMapping;
158     
159     // Should return iterators
160     bool getOrigRanges(pdvector<codeRange *> &);
161     bool getModifiedRanges(pdvector<codeRange *> &);
162
163     // Multitramp convenience functions
164     multiTramp *findMultiTrampByAddr(Address addr);
165     multiTramp *findMultiTrampById(unsigned int id);
166     void addMultiTramp(multiTramp *multi);
167     void removeMultiTramp(multiTramp *multi);
168
169     // Function replacement (or relocated, actually) convenience functions
170     functionReplacement *findFuncReplacement(Address addr);
171     void addFuncReplacement(functionReplacement *funcrep);
172     void removeFuncReplacement(functionReplacement *funcrep);
173
174     // Function call replacement convenience functions
175     replacedFunctionCall *findReplacedCall(Address addr);
176     void addReplacedCall(replacedFunctionCall *rep);
177     void removeReplacedCall(replacedFunctionCall *rep);
178
179     //////////////////////////////////////////////////////////////
180     // Function/variable lookup code
181     // Turns out that instrumentation needs this... so the 
182     // AddressSpace keeps growing. 
183     //////////////////////////////////////////////////////////////
184
185     // findFuncByName: returns function associated with "func_name"
186     // This routine checks both the a.out image and any shared object images 
187     // for this function
188     //int_function *findFuncByName(const pdstring &func_name);
189     
190     bool findFuncsByAll(const pdstring &funcname,
191                         pdvector<int_function *> &res,
192                         const pdstring &libname = "");
193     
194     // Specific versions...
195     bool findFuncsByPretty(const pdstring &funcname,
196                            pdvector<int_function *> &res,
197                            const pdstring &libname = "");
198     bool findFuncsByMangled(const pdstring &funcname, 
199                             pdvector<int_function *> &res,
200                             const pdstring &libname = "");
201     
202     bool findVarsByAll(const pdstring &varname,
203                        pdvector<int_variable *> &res,
204                        const pdstring &libname = "");
205     
206     // And we often internally want to wrap the above to return one
207     // and only one func...
208     int_function *findOnlyOneFunction(const std::string &name,
209                                       const std::string &libname = "");
210
211     // getAllFunctions: returns a vector of all functions defined in the
212     // a.out and in the shared objects
213     void getAllFunctions(pdvector<int_function *> &);
214     
215     // Find the code sequence containing an address
216     // Note: fix the name....
217     int_function *findFuncByAddr(Address addr);
218     int_basicBlock *findBasicBlockByAddr(Address addr);
219     
220     // And a lookup by "internal" function to find clones during fork...
221     int_function *findFuncByInternalFunc(image_func *ifunc);
222     
223     //findJumpTargetFuncByAddr Acts like findFunc, but if it fails,
224     // checks if 'addr' is a jump to a function.
225     int_function *findJumpTargetFuncByAddr(Address addr);
226     
227     // findModule: returns the module associated with "mod_name" 
228     // this routine checks both the a.out image and any shared object 
229     // images for this module
230     // if check_excluded is true it checks to see if the module is excluded
231     // and if it is it returns 0.  If check_excluded is false it doesn't check
232     //  if substring_match is true, the first module whose name contains
233     //  the provided string is returned.
234     // Wildcard: handles "*" and "?"
235     mapped_module *findModule(const pdstring &mod_name, bool wildcard = false);
236     // And the same for objects
237     // Wildcard: handles "*" and "?"
238     mapped_object *findObject(const pdstring &obj_name, bool wildcard = false);
239     mapped_object *findObject(Address addr);
240
241     mapped_object *getAOut() { assert(mapped_objects.size()); return mapped_objects[0];}
242     
243     // getAllModules: returns a vector of all modules defined in the
244     // a.out and in the shared objects
245     void getAllModules(pdvector<mapped_module *> &);
246
247     // return the list of dynamically linked libs
248     const pdvector<mapped_object *> &mappedObjects() { return mapped_objects;  } 
249     
250     // If true is passed for ignore_if_mt_not_set, then an error won't be
251     // initiated if we're unable to determine if the program is multi-threaded.
252     // We are unable to determine this if the daemon hasn't yet figured out
253     // what libraries are linked against the application.  Currently, we
254     // identify an application as being multi-threaded if it is linked against
255     // a thread library (eg. libpthreads.a on AIX).  There are cases where we
256     // are querying whether the app is multi-threaded, but it can't be
257     // determined yet but it also isn't necessary to know.
258     virtual bool multithread_capable(bool ignore_if_mt_not_set = false) = 0;
259     
260     // Do we have the RT-side multithread functions available
261     virtual bool multithread_ready(bool ignore_if_mt_not_set = false) = 0;
262
263     //////////////////////////////////////////////////////
264     // Process-level instrumentation (?)
265     /////////////////////////////////////////////////////
266
267     // instPoint isn't const; it may get an updated list of
268     // instances since we generate them lazily.
269     // Shouldn't this be an instPoint member function?
270     bool replaceFunctionCall(instPoint *point,const int_function *newFunc);
271     
272     // And this....
273     bool getDynamicCallSiteArgs(instPoint *callSite, 
274                                 pdvector<AstNodePtr> &args);
275
276     // Default to "nope"
277     virtual bool hasBeenBound(const relocationEntry &, 
278                               int_function *&, 
279                               Address) { return false; }
280     
281     // Trampoline guard get/set functions
282     Address trampGuardBase(void) { return trampGuardBase_; }
283     AstNodePtr trampGuardAST(void);
284
285     // Get the current code generator (or emitter)
286     Emitter *getEmitter();
287
288     // Should be easy if the process isn't _executing_ where
289     // we're deleting...
290     virtual void deleteGeneratedCode(generatedCodeObject *del);
291
292     //////////////////////////////////////////////////////
293     // BPatch-level stuff
294     //////////////////////////////////////////////////////
295     // Callbacks for higher level code (like BPatch) to learn about new 
296     //  functions and InstPoints.
297  private:
298     BPatch_function *(*new_func_cb)(AddressSpace *a, int_function *f);
299     BPatch_point *(*new_instp_cb)(AddressSpace *a, int_function *f, instPoint *ip, 
300                                   int type);
301  public:
302     //Trigger the callbacks from a lower level
303     BPatch_function *newFunctionCB(int_function *f) 
304         { assert(new_func_cb); return new_func_cb(this, f); }
305     BPatch_point *newInstPointCB(int_function *f, instPoint *pt, int type)
306         { assert(new_instp_cb); return new_instp_cb(this, f, pt, type); }
307     
308     //Register callbacks from the higher level
309     void registerFunctionCallback(BPatch_function *(*f)(AddressSpace *p, 
310                                                         int_function *f))
311         { new_func_cb = f; };
312     void registerInstPointCallback(BPatch_point *(*f)(AddressSpace *p, int_function *f,
313                                                       instPoint *ip, int type))
314         { new_instp_cb = f; }
315     
316     
317     //Anonymous up pointer to the containing process.  This is BPatch_process
318     // in Dyninst.  Currently stored as an void pointer in case we do
319     // anything with this during the library split.
320     void *up_ptr() { return up_ptr_; }
321     void set_up_ptr(void *ptr) { up_ptr_ = ptr; }
322     
323     //////////////////////////////////////////////////////
324     // Internal and cleanup 
325     //////////////////////////////////////////////////////
326
327     // Clear things out (e.g., deleteProcess)
328     void deleteAddressSpace();
329     // Fork psuedo-constructor
330     void copyAddressSpace(process *parent);
331
332     // Aaand constructor/destructor
333     AddressSpace();
334     virtual ~AddressSpace();
335
336
337     //////////////////////////////////////////////////////
338     // Yuck
339     //////////////////////////////////////////////////////
340     Address getObservedCostAddr() const { return costAddr_; }
341     void updateObservedCostAddr(Address addr) { costAddr_ = addr;}
342
343
344  protected:
345
346     // inferior malloc support functions
347     void inferiorFreeCompact();
348     int findFreeIndex(unsigned size, int type, Address lo, Address hi);
349     void addHeap(heapItem *h);
350     void initializeHeap();
351     
352     // Centralization of certain inferiorMalloc operations
353     Address inferiorMallocInternal(unsigned size, Address lo, Address hi, 
354                                    inferiorHeapType type);
355     void inferiorMallocAlign(unsigned &size);
356
357     bool heapInitialized_;
358     inferiorHeap heap_;
359
360     // Text sections (including added - instrumentation)
361     codeRangeTree textRanges_;
362     // Data sections
363     codeRangeTree dataRanges_;
364     // And address-space-wide patches that we've dropped in
365     codeRangeTree modifiedRanges_;
366
367     // We label multiTramps by ID
368     dictionary_hash<int, multiTramp *> multiTrampsById_;
369
370     // Loaded mapped objects (may be just 1)
371     pdvector<mapped_object *> mapped_objects;
372
373     Address trampGuardBase_; // Tramp recursion index mapping
374     AstNodePtr trampGuardAST_;
375
376     void *up_ptr_;
377
378     Address costAddr_;
379
380     
381 };
382
383 extern int heapItemCmpByAddr(const heapItem **A, const heapItem **B);
384
385 #endif // ADDRESS_SPACE_H