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