This commit enables arbitrary instrumentation points at the last instruction
[dyninst.git] / dyninstAPI / h / BPatch_image.h
1 /*
2  * Copyright (c) 1996 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 #ifndef _BPatch_image_h_
43 #define _BPatch_image_h_
44
45 #include "BPatch_dll.h"
46 #include "BPatch_sourceObj.h"
47 #include "BPatch_Vector.h"
48 #include "BPatch_point.h"
49 #include "BPatch_snippet.h"
50 #include "BPatch_module.h"
51 #include "BPatch_type.h"
52
53 class process;
54 class image;
55
56 class AddrToVarExprHash;
57
58 #ifdef IBM_BPATCH_COMPAT
59 #ifdef __linux__
60
61 typedef enum BPatch_LpModel {
62     LP32,      /* 32 bit image */
63         LP64,      /* 64 bit image */
64     UNKNOWN_LP /* cannot be determined */
65 };
66
67 #endif
68 #endif
69
70 class BPATCH_DLL_EXPORT BPatch_image: public BPatch_sourceObj {
71     process     *proc;
72
73     void findFunctionInImage(const char *name, image *img,
74                              BPatch_Vector<BPatch_function*>& funcs);
75 public:
76 // The following functions are for internal use by  the library only:
77     BPatch_image(process *_proc);
78     BPatch_image();
79     virtual ~BPatch_image();
80
81     bool                 ModuleListExist();
82     void                 addModuleIfExist(BPatch_module *bpmod);
83
84     BPatch_variableExpr *createVarExprByName(BPatch_module *mod, const char *name);
85
86 // End functions for internal use only
87
88     bool getSourceObj(BPatch_Vector<BPatch_sourceObj *> &);
89     BPatch_sourceObj *getObjParent();
90     bool getVariables(BPatch_Vector<BPatch_variableExpr *> &);
91   
92     BPatch_Vector<BPatch_function *> *getProcedures();
93     BPatch_Vector<BPatch_module *> *getModules();
94
95     BPatch_Vector<BPatch_variableExpr *> *getGlobalVariables();
96
97     BPatch_point *createInstPointAtAddr(void *address);
98
99     BPatch_point *createInstPointAtAddr(void *address,
100                                         BPatch_point** alternative,
101                                         BPatch_function* bpf = NULL);
102
103
104     BPatch_function     *findFunction(const char *name, bool showError=true);
105     BPatch_function     *findBPFunction(const char *name);
106 BPatch_Vector<BPatch_function *>  *findBPFunction(const char *name,
107                                                   BPatch_Vector<BPatch_function *> &funclist);
108     BPatch_variableExpr *findVariable(const char *name, bool showError=true);
109     BPatch_variableExpr *findVariable(BPatch_point &scp, const char *nm); 
110
111     BPatch_type         *findType(const char *name);
112
113     //method to retrieve addresses corresponding to a line in a file
114     bool getLineToAddr(const char* fileName,unsigned short lineNo,
115                        BPatch_Vector<unsigned long>& buffer,
116                        bool exactMatch = true);
117 #ifdef IBM_BPATCH_COMPAT
118     char *programName(char *name, unsigned int len);
119     char *getProgramName(char *name, unsigned int len);
120     int  lpType();
121 #endif
122
123     BPatch_Vector<BPatch_function*>     *findFunction(const char *name, BPatch_Vector<BPatch_function*> &funcs, bool showError=true);
124
125 private:
126     BPatch_Vector<BPatch_module *> *modlist;
127     AddrToVarExprHash *AddrToVarExpr;
128 };
129
130 #endif /* _BPatch_image_h_ */