Compile fix after removing deprecated SymtabAPI methods.
[dyninst.git] / symtabAPI / src / SymtabReader.C
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #include "symtabAPI/h/SymtabReader.h"
32 #include "symtabAPI/h/Symtab.h"
33 #include "symtabAPI/h/Symbol.h"
34 #include "symtabAPI/h/Function.h"
35
36 #include "symtabAPI/src/Object.h"
37
38 #include <sstream>
39 using std::stringstream;
40
41 using namespace Dyninst;
42 using namespace SymtabAPI;
43
44 SymtabReader::SymtabReader(std::string file_) :
45    symtab(NULL),
46    ref_count(1),
47    mapped_regions(NULL),
48    dwarf_handle(NULL),
49    ownsSymtab(true)
50 {
51   // We'd throw, but...
52   (void)Symtab::openFile(symtab, file_);
53 }
54
55 SymtabReader::SymtabReader(const char *buffer, unsigned long size) :
56    symtab(NULL),
57    ref_count(1),
58    mapped_regions(NULL),
59    dwarf_handle(NULL),
60    ownsSymtab(true)
61 {
62    stringstream memName;
63    memName << "memory_" << (unsigned long)(buffer) << "_" << size;
64    Symtab::openFile(symtab, const_cast<char *>(buffer), 
65                     size, memName.str());
66 }
67
68 SymtabReader::SymtabReader(Symtab *s) :
69     symtab(s),
70     ref_count(1),
71     mapped_regions(NULL),
72     dwarf_handle(NULL),
73     ownsSymtab(false)
74 {}
75
76 SymtabReader::~SymtabReader()
77 {
78    if (mapped_regions)
79       delete mapped_regions;
80    if (symtab && ownsSymtab)
81       Symtab::closeSymtab(symtab);
82    symtab = NULL;
83    mapped_regions = NULL;
84 #if !defined(os_windows)
85    if (dwarf_handle)
86      delete dwarf_handle;
87 #endif
88    dwarf_handle = NULL;
89 }
90
91
92 #define DEFN_SYMBOL_T(name) Symbol_t name; name.v1 = name.v2 = NULL; name.i1 = name.i2 = 0
93
94 Symbol_t SymtabReader::getSymbolByName(std::string symname)
95 {
96    assert(symtab);
97    DEFN_SYMBOL_T(ret);
98
99    std::vector<Symbol *> syms;
100    bool result = symtab->findSymbol(syms, symname);
101    if (!result || syms.empty()) {
102       return ret;
103    }
104
105    ret.v1 = symtab;
106    ret.v2 = syms[0];
107    return ret;
108 }
109
110 Symbol_t SymtabReader::getContainingSymbol(Dyninst::Offset offset)
111 {
112    assert(symtab);
113    DEFN_SYMBOL_T(ret);
114
115    Function *f = NULL;
116    bool result = symtab->getContainingFunction(offset, f);
117    if (!result || !f) {
118       return ret;
119    }
120
121    ret.v1 = symtab;
122    ret.v2 = f->getFirstSymbol();
123    return ret;
124 }
125
126 std::string SymtabReader::getInterpreterName()
127 {
128    assert(symtab);
129    const char *interp = NULL;
130    interp = symtab->getInterpreterName();
131
132    if (!interp)
133       return std::string();
134    return std::string(interp);
135 }
136
137 unsigned SymtabReader::getAddressWidth()
138 {
139    assert(symtab);
140    return symtab->getAddressWidth();
141 }
142    
143 unsigned SymtabReader::numRegions()
144 {
145    assert(symtab);
146    if (!mapped_regions) {
147       mapped_regions = new std::vector<Region *>();
148       bool result = symtab->getMappedRegions(*mapped_regions);
149       if (!result) {
150          return 0;
151       }
152    }
153    return mapped_regions->size();
154 }
155
156 bool SymtabReader::getRegion(unsigned num, SymRegion &reg)
157 {
158    assert(symtab);
159    if (!mapped_regions) {
160       mapped_regions = new std::vector<Region *>();
161       bool result = symtab->getMappedRegions(*mapped_regions);
162       if (!result) {
163          return false;
164       }
165    }
166
167    if (num >= mapped_regions->size())
168       return false;
169    Region *region = (*mapped_regions)[num];
170    reg.file_offset = region->getDiskOffset();
171    reg.mem_addr = region->getMemOffset();
172    reg.file_size = region->getDiskSize();
173    reg.mem_size = region->getMemSize();
174    reg.type = (int) region->getRegionType();
175    return true;
176 }
177
178 Dyninst::Offset SymtabReader::getSymbolOffset(const Symbol_t &sym)
179 {
180    assert(sym.v2);
181    Symbol *symbol = (Symbol *) sym.v2;
182    return symbol->getOffset();
183 }
184
185 std::string SymtabReader::getSymbolName(const Symbol_t &sym)
186 {
187    assert(sym.v2);
188    Symbol *symbol = (Symbol *) sym.v2;
189    return symbol->getMangledName();
190 }
191
192 std::string SymtabReader::getDemangledName(const Symbol_t &sym) {
193    assert(sym.v2);
194    Symbol *symbol = (Symbol *) sym.v2;
195    return symbol->getTypedName();
196 }
197
198 unsigned long SymtabReader::getSymbolSize(const Symbol_t &sym)
199 {
200    assert(sym.v2);
201    Symbol *symbol = (Symbol *) sym.v2;
202    return symbol->getSize();
203 }
204
205 bool SymtabReader::isValidSymbol(const Symbol_t &sym)
206 {
207    return (sym.v1 != NULL) && (sym.v2 != NULL);
208 }
209
210 Dyninst::Offset SymtabReader::imageOffset()
211 {
212    return symtab->imageOffset();
213 }
214
215 Dyninst::Offset SymtabReader::dataOffset()
216 {
217    return symtab->dataOffset();
218 }
219
220 Section_t SymtabReader::getSectionByName(std::string name)
221 {
222    Region *region;
223    Section_t ret;
224    ret.v1 = NULL;
225    bool result = symtab->findRegion(region, name);
226    if (!result) {
227       return ret;
228    }
229    ret.v1 = (void *) region;
230    return ret;
231 }
232
233 Section_t SymtabReader::getSectionByAddress(Dyninst::Address addr)
234 {
235    Region *region = symtab->findEnclosingRegion(addr);
236    Section_t ret;
237    ret.v1 = (void *) region;
238    return ret;
239 }
240
241 Dyninst::Address SymtabReader::getSectionAddress(Section_t sec)
242 {
243    Region *region = (Region *) sec.v1;
244    assert(region);
245    return region->getMemOffset();
246 }
247
248 std::string SymtabReader::getSectionName(Section_t sec)
249 {
250    Region *region = (Region *) sec.v1;
251    assert(region);
252    return region->getRegionName();
253 }
254
255 bool SymtabReader::isValidSection(Section_t sec)
256 {
257    return (sec.v1 != NULL);
258 }
259
260 void *SymtabReader::getDebugInfo()
261 {
262 #if defined(os_solaris) || defined(os_linux) || defined(os_bg_ion) || defined(os_freebsd) || defined(os_vxworks)
263   if (!dwarf_handle)
264   {
265     Object *obj = symtab->getObject();
266     dwarf_handle = new DwarfHandle(obj);
267   }
268   Dwarf_Debug dbg = *(dwarf_handle->dbg());
269   return (void *) dbg;
270 #else
271   return NULL;
272 #endif
273 }
274
275 void *SymtabReader::getElfHandle()
276 {
277 #if defined(os_solaris) || defined(os_linux) || defined(os_bg_ion) || defined(os_freebsd) || defined(os_vxworks)
278    Object *obj = symtab->getObject();
279    return obj->getElfHandle();
280 #else
281    return NULL;
282 #endif
283 }
284
285 SymtabReaderFactory::SymtabReaderFactory()
286 {
287 }
288
289 SymtabReaderFactory::~SymtabReaderFactory()
290 {
291 }
292
293 SymReader *SymtabReaderFactory::openSymbolReader(std::string pathname)
294 {
295    std::map<std::string, SymReader *>::iterator i = open_syms.find(pathname);
296    if (i != open_syms.end()) {
297       SymtabReader *symtabreader = static_cast<SymtabReader *>(i->second);
298       symtabreader->ref_count++;
299       return symtabreader;
300    }
301    SymtabReader *symtabreader = new SymtabReader(pathname);
302    if (!symtabreader) { 
303       return NULL;
304    }
305    open_syms[pathname] = symtabreader;
306    return symtabreader;
307 }
308
309 SymReader *SymtabReaderFactory::openSymbolReader(const char *buffer, unsigned long size)
310 {
311    SymtabReader *symtabreader = new SymtabReader(buffer, size);
312    if (!symtabreader) 
313       return NULL;
314    return symtabreader;
315 }
316
317 bool SymtabReaderFactory::closeSymbolReader(SymReader *sr)
318 {
319    SymtabReader *symreader = static_cast<SymtabReader *>(sr);
320    assert(symreader->ref_count >= 1);
321    symreader->ref_count--;
322    if (symreader->ref_count == 0) {
323       delete symreader;
324    }
325    return true;
326 }
327
328 SymbolReaderFactory *Dyninst::SymtabAPI::getSymtabReaderFactory()
329 {
330    static SymtabReaderFactory *fact = NULL;
331    if (!fact)
332       fact = new SymtabReaderFactory();
333    return static_cast<SymbolReaderFactory *>(fact);
334 }