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