Initial dyninstAPI commit for code coverage
[dyninst.git] / dyninstAPI / h / BPatch_module.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_module_h_
43 #define _BPatch_module_h_
44
45 #include "BPatch_dll.h"
46 #include <BPatch_Vector.h>
47 #include <BPatch_sourceObj.h>
48
49 class pdmodule;
50 class BPatch_image;
51 class BPatch_function;
52 class BPatch_typeCollection;
53 class BPatch_builtInTypeCollection;
54 class LineInformation;
55
56 extern BPatch_builtInTypeCollection * builtInTypes;
57
58
59 class BPATCH_DLL_EXPORT BPatch_module: public BPatch_sourceObj {
60
61     friend class BPatch_function;
62     friend class BPatch_image;
63     friend class BPatch_thread;
64     friend class BPatch_flowGraph;
65
66     process             *proc;
67     pdmodule            *mod;
68     BPatch_image        *img;
69     BPatch_Vector<BPatch_function *> * BPfuncs;
70     LineInformation* lineInformation;
71      
72 public:
73 // The following functions are for internal use by  the library only:
74     BPatch_module(process *_proc, pdmodule *_mod, BPatch_image *img);
75     BPatch_module() : mod(NULL), img(NULL), BPfuncs(NULL),lineInformation(NULL) {
76         _srcType = BPatch_sourceModule;
77     };
78
79     virtual ~BPatch_module();
80
81     bool getSourceObj(BPatch_Vector<BPatch_sourceObj *>&);
82     BPatch_sourceObj *getObjParent();
83     bool getVariables(BPatch_Vector<BPatch_variableExpr *> &);
84
85     BPatch_typeCollection *moduleTypes;
86
87 // End functions for internal use only
88   
89     char *getName(char *buffer, int length);
90     char *getFullName(char *buffer, int length);
91
92     BPatch_Vector<BPatch_function *> *getProcedures();
93
94     BPatch_function *findFunction(const char * name);
95
96     // parse stab stuff when needed
97     void parseTypes();
98
99
100     char *parseStabStringSymbol(int line, char *stabstr, void *stabptr);
101
102 //function to get addresses for a line of the module
103     bool getLineToAddr(unsigned short lineNo,
104                        BPatch_Vector<unsigned long>& buffer,
105                        bool exactMatch = true);
106
107     LineInformation* getLineInformation();
108
109 #ifdef IBM_BPATCH_COMPAT
110     bool getLineNumbers(unsigned int &start, unsigned int &end);
111     char *getUniqueString(char *buffer, int length);
112
113     char *sharedLibraryName(char *buffer, int length) { getFullName(buffer, length); }
114     char *getSharedLibName(char *buffer, int length) { getFullName(buffer, length); }
115     int getSharedLibType();
116     int getBindingType();
117 #endif
118
119 private:
120
121 };
122
123 #ifdef IBM_BPATCH_COMPAT
124 #define BPatch_sharedPublic     1
125 #define BPatch_sharedPrivate    2
126 #define BPatch_nonShared        3
127
128 #define BPatch_static           1
129 #define BPatch_dynamic          2
130
131 #endif
132
133 #endif /* _BPatch_module_h_ */