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