Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / src / mapped_module.h
1 /*
2  * Copyright (c) 1996-2009 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  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 // $Id: mapped_module.h,v 1.14 2008/08/01 17:55:13 roundy Exp $
33
34 #if !defined(mapped_module_h)
35 #define mapped_module_h
36
37 class mapped_module;
38 class mapped_object;
39
40 class int_function;
41 class int_variable;
42
43 class parse_image;
44 class pdmodule;
45 class image;
46
47 #include <string>
48 #include "common/h/Types.h"
49 #include "dyninstAPI/src/symtab.h"
50 #include "symtabAPI/h/Symtab.h"
51
52 #define CHECK_ALL_CALL_POINTS  // paradyn might need it
53
54
55 // pdmodule equivalent The internals tend to use images, while the
56 // BPatch layer uses modules. On the other hand, "module" means
57 // "compilation unit for the a.out, or the entire image for a
58 // library". At some point this will need to be fixed, which will be a
59 // major pain.
60
61 class mapped_module {
62    public:
63       static mapped_module *createMappedModule(mapped_object *obj,
64             pdmodule *pdmod);
65
66       mapped_object *obj() const;
67       pdmodule *pmod() const;
68
69       const string &fileName() const;
70       const string &fullName() const;
71
72       AddressSpace *proc() const;
73
74       // A lot of stuff shared with the internal module
75       // Were we compiled with the native compiler?
76       bool isNativeCompiler() const;
77
78       supportedLanguages language() const;
79
80       const pdvector<int_function *> &getAllFunctions();
81       const pdvector<int_variable *> &getAllVariables();
82
83       bool findFuncVectorByPretty(const std::string &funcname,
84             pdvector<int_function *> &funcs);
85
86       // Yeah, we can have multiple mangled matches -- for libraries there
87       // is a single module. Even if we went multiple, we might not have
88       // module information, and so we can get collisions.
89       bool findFuncVectorByMangled(const std::string &funcname,
90             pdvector<int_function *> &funcs);
91
92       int_function *findFuncByAddr(const Address &address);
93       codeRange *findCodeRangeByAddress(const Address &address);
94
95
96       void dumpMangled(std::string prefix) const;
97
98       /////////////////////////////////////////////////////
99       // Line information
100       /////////////////////////////////////////////////////
101       // Line info is something we _definitely_ don't want multiple copies
102       // of. So instead we provide pass-through functions that handle
103       // things like converting absolute addresses (external) into offsets
104       // (internal).  Its all in SymtabAPI now
105
106       std::string processDirectories(const std::string &fn) const;
107
108       // Given a line in the module, get the set of addresses that it maps
109       // to. Calls the internal getAddrFromLine and then adds the base
110       // address to the returned list of offsets.
111       bool getAddrFromLine(unsigned lineNum,
112             pdvector<Address> &addresses,
113             bool exactMatch);
114
115       void addFunction(int_function *func);
116       void addVariable(int_variable *var);
117       int_variable* createVariable(std::string name, Address offset, int size);
118       
119
120       static bool truncateLineFilenames;
121       int getFuncVectorSize() { return everyUniqueFunction.size(); }
122
123    private:
124
125       pdmodule *internal_mod_;
126       mapped_object *obj_;
127
128       mapped_module();
129       mapped_module(mapped_object *obj,
130             pdmodule *pdmod);
131
132       pdvector<int_function *> everyUniqueFunction;
133       pdvector<int_variable *> everyUniqueVariable;
134 };
135
136 #endif