This commit enables arbitrary instrumentation points at the last instruction
[dyninst.git] / dyninstAPI / h / BPatch_function.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_function_h_
43 #define _BPatch_function_h_
44
45 #include "BPatch_dll.h"
46 #include "BPatch_Vector.h"
47 #include "BPatch_point.h"
48 #include "BPatch_type.h"
49 #include "BPatch_module.h"
50 #include "BPatch_flowGraph.h"
51 #include "BPatch_memoryAccess_NP.h"
52
53 class function_base;
54 class process;
55
56 class BPatch_localVarCollection;
57 class BPatch_function;
58 class BPatch_point;
59 class BPatch_flowGraph;
60
61 class BPATCH_DLL_EXPORT BPatch_function: public BPatch_sourceObj {
62     friend class BPatch_flowGraph;
63     friend class InstrucIter;
64
65     process *proc;
66     BPatch_type * retType;
67     BPatch_Vector<BPatch_localVar *> params;
68     BPatch_module *mod;
69     BPatch_flowGraph* cfg;
70
71     void *getBaseAddrRelative() const;
72     BPatch_point* createMemInstPoint(void *addr, BPatch_memoryAccess* ma);
73
74     // VG(02/19/02): FIXME: update this somehow on relocation
75 #if defined(i386_unknown_linux2_0) ||\
76  defined(i386_unknown_solaris2_5) ||\
77  defined(i386_unknown_nt4_0) ||\
78  defined(ia64_unknown_linux2_4) /* Temporary duplication - TLM */
79
80   // needed to workaround gcc 3.0.2 problem (bug?)
81   typedef const unsigned char* InstrucPos;
82
83   InstrucPos *iptrs;
84 #endif
85
86 public:
87     virtual     ~BPatch_function();
88
89 // The following are for  internal use by the library only:
90     function_base *func;
91     process *getProc() const { return proc; }
92
93 // No longer inline but defined in .C file
94     BPatch_function(process *_proc, function_base *_func, BPatch_module *mod = NULL);
95     BPatch_function(process *_proc, function_base *_func,
96                     BPatch_type * _retType, BPatch_module *);
97
98     bool getSourceObj(BPatch_Vector<BPatch_sourceObj *> &);
99     BPatch_sourceObj *getObjParent();
100     BPatch_localVarCollection * localVariables;
101     BPatch_localVarCollection * funcParameters;
102     void setReturnType( BPatch_type * _retType){
103       retType = _retType;}
104     
105 // For users of the library:
106     char         *getName(char *s, int len) const;
107     char         *getMangledName(char *s, int len) const;
108     void         *getBaseAddr() const;
109     unsigned int getSize() const;
110
111     BPatch_type * getReturnType(){ return retType; }
112     BPatch_module *getModule()  { return mod; }
113     void addParam(char * _name, BPatch_type *_type, int _linenum,
114                   int _frameOffset, int _sc = 5 /* scAbs */ );
115     
116     BPatch_Vector<BPatch_localVar *> *getParams() { 
117       return &params; }
118     BPatch_Vector<BPatch_localVar *> *getVars();
119     BPatch_Vector<BPatch_point *>
120         *findPoint(const BPatch_procedureLocation loc);
121     BPatch_Vector<BPatch_point *>
122         *findPoint(const BPatch_Set<BPatch_opCode>& ops);
123     BPatch_localVar * findLocalVar( const char * name);
124     BPatch_localVar * findLocalParam(const char * name);
125     BPatch_Vector<BPatch_variableExpr *> *findVariable(const char *);
126
127     //method to retrieve addresses corresponding a line in the function
128     bool getLineToAddr (unsigned short lineNo,
129                         BPatch_Vector<unsigned long>& buffer,
130                         bool exactMatch = true);
131
132     // method to return file name, and first and last lines of the func
133     bool getLineAndFile(unsigned int &start, 
134                         unsigned int &end, 
135                         char *name,
136                         unsigned &length);
137
138     // is this defined, what variables should be returned??
139     bool getVariables(BPatch_Vector<BPatch_variableExpr *> &vect);
140
141     char *getModuleName(char *name, int maxLen);
142
143     // Returns true if the function is instrumentable.
144     bool isInstrumentable();
145
146     bool isSharedLib() const;
147
148 #ifdef IBM_BPATCH_COMPAT
149     bool getLineNumbers(unsigned int &start, unsigned int &end);
150
151     void *getAddress();
152     
153     bool getAddressRange(void * &start, void * &end);
154
155     BPatch_type *returnType();
156
157     void getIncPoints(BPatch_Vector<BPatch_point *> &vect);
158
159
160     int getMangledNameLen();
161
162     void getExcPoints(BPatch_Vector<BPatch_point*> &points);
163
164     // return a function that can be passed as a paramter
165     BPatch_variableExpr *getFunctionRef();
166
167  
168 #endif
169                 
170
171 //method to create the control flow graph for the function
172     BPatch_flowGraph* getCFG();
173 };
174
175 #endif /* _BPatch_function_h_ */